From a59c5174556a9bb4a1045faa9923f09b7cbb43e8 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 4 Feb 2026 11:28:49 +0000 Subject: [PATCH] ## Csharp SDK Changes: * `Codat.lending.Banking.CategorizedStatement.Get()`: `response.reportItems[].Transactions[].IsRecurring` **Added** --- .speakeasy/logs/changes/changes.html | 104 + .speakeasy/logs/changes/changes.md | 2 + .speakeasy/logs/changes/new.openapi.yaml | 86068 ++++++++++++++++ .speakeasy/logs/changes/old.openapi.yaml | 85028 +++++++++++++++ .speakeasy/workflow.lock | 14 +- lending/.speakeasy/gen.lock | 2994 +- lending/.speakeasy/gen.yaml | 3 +- lending/Codat/Lending/AccountBalances.cs | 59 +- lending/Codat/Lending/AccountTransactions.cs | 106 +- lending/Codat/Lending/AccountingBankData.cs | 64 +- lending/Codat/Lending/Accounts.cs | 103 +- lending/Codat/Lending/AccountsPayable.cs | 30 +- lending/Codat/Lending/AccountsReceivable.cs | 42 +- lending/Codat/Lending/BalanceSheet.cs | 92 +- lending/Codat/Lending/BankAccounts.cs | 107 +- lending/Codat/Lending/BankStatements.cs | 232 +- lending/Codat/Lending/BankTransactions.cs | 111 +- lending/Codat/Lending/Banking.cs | 36 +- lending/Codat/Lending/BillCreditNotes.cs | 106 +- lending/Codat/Lending/BillPayments.cs | 106 +- lending/Codat/Lending/Bills.cs | 251 +- lending/Codat/Lending/CashFlow.cs | 50 +- lending/Codat/Lending/CategorizedStatement.cs | 56 +- lending/Codat/Lending/Codat.Lending.csproj | 2 +- lending/Codat/Lending/CodatLending.cs | 142 +- lending/Codat/Lending/CodatLendingAccounts.cs | 106 +- .../Lending/CodatLendingBankingAccounts.cs | 103 +- .../Codat/Lending/CodatLendingCustomers.cs | 106 +- .../Codat/Lending/CodatLendingDirectCosts.cs | 111 +- .../CodatLendingLoanWritebackAccounts.cs | 101 +- .../CodatLendingLoanWritebackPayments.cs | 101 +- lending/Codat/Lending/CodatLendingPayments.cs | 106 +- lending/Codat/Lending/CodatLendingReports.cs | 170 +- .../Lending/CodatLendingSalesTransactions.cs | 106 +- .../Codat/Lending/CodatLendingSuppliers.cs | 107 +- .../Codat/Lending/CodatLendingTransactions.cs | 106 +- .../Codat/Lending/CodatLendingTransfers.cs | 104 +- lending/Codat/Lending/Companies.cs | 280 +- lending/Codat/Lending/CompanyInfo.cs | 96 +- lending/Codat/Lending/Connections.cs | 206 +- lending/Codat/Lending/CreateOperations.cs | 90 +- lending/Codat/Lending/CreditNotes.cs | 106 +- lending/Codat/Lending/Customers.cs | 235 +- lending/Codat/Lending/DataIntegrity.cs | 143 +- lending/Codat/Lending/DirectCosts.cs | 244 +- lending/Codat/Lending/DirectIncomes.cs | 242 +- lending/Codat/Lending/Disputes.cs | 106 +- lending/Codat/Lending/ExcelReports.cs | 158 +- lending/Codat/Lending/FileUpload.cs | 126 +- lending/Codat/Lending/FinancialStatements.cs | 30 +- lending/Codat/Lending/Hooks/HookTypes.cs | 23 +- lending/Codat/Lending/Hooks/SDKHooks.cs | 48 + lending/Codat/Lending/Invoices.cs | 335 +- lending/Codat/Lending/JournalEntries.cs | 110 +- lending/Codat/Lending/Journals.cs | 106 +- lending/Codat/Lending/Liabilities.cs | 208 +- lending/Codat/Lending/LoanWriteback.cs | 60 +- lending/Codat/Lending/Locations.cs | 106 +- lending/Codat/Lending/ManageData.cs | 58 +- lending/Codat/Lending/ManageReports.cs | 93 +- lending/Codat/Lending/Metrics.cs | 219 +- .../Models/Components/AccountBalance.cs | 11 +- .../Components/AccountBalanceAmounts.cs | 5 +- .../AccountCategoriesUpdatedWebhook.cs | 7 +- .../AccountCategoriesUpdatedWebhookData.cs | 8 +- .../Models/Components/AccountCategoryLevel.cs | 3 +- .../Components/AccountIdentifierType.cs | 5 +- .../Models/Components/AccountIdentifiers.cs | 14 +- .../Lending/Models/Components/AccountInfo.cs | 8 +- .../Models/Components/AccountInstitution.cs | 7 +- .../Models/Components/AccountPrototype.cs | 23 +- .../AccountPrototypeValidDataTypeLinks.cs | 30 +- .../Lending/Models/Components/AccountRef.cs | 3 +- .../Models/Components/AccountStatus.cs | 5 +- .../Components/AccountTransactionLine.cs | 3 +- .../AccountTransactionLineRecordRef.cs | 5 +- ...AccountTransactionLineRecordRefDataType.cs | 3 +- .../Lending/Models/Components/AccountType.cs | 5 +- .../Models/Components/AccountingAccount.cs | 32 +- .../AccountingAccountTransaction.cs | 19 +- .../AccountingAccountTransactionStatus.cs | 3 +- .../AccountingAccountTransactions.cs | 3 +- .../Models/Components/AccountingAccounts.cs | 3 +- .../Models/Components/AccountingAddress.cs | 5 +- .../Components/AccountingAddressType.cs | 5 +- .../AccountingAgedCreditorReport.cs | 22 +- .../Components/AccountingAgedDebtorReport.cs | 22 +- .../Models/Components/AccountingAttachment.cs | 21 +- .../Components/AccountingBalanceSheet.cs | 21 +- .../Components/AccountingBankAccount.cs | 24 +- .../Components/AccountingBankAccountType.cs | 6 +- .../Components/AccountingBankAccounts.cs | 3 +- .../Components/AccountingBankTransaction.cs | 11 +- .../Components/AccountingBankTransactions.cs | 3 +- .../Models/Components/AccountingBill.cs | 19 +- .../Components/AccountingBillCreditNote.cs | 33 +- .../Components/AccountingBillCreditNotes.cs | 3 +- .../Components/AccountingBillPayment.cs | 25 +- .../Components/AccountingBillPayments.cs | 3 +- .../Models/Components/AccountingBills.cs | 3 +- .../Components/AccountingCashFlowStatement.cs | 21 +- .../Components/AccountingCompanyInfo.cs | 27 +- .../AccountingCreateAccountResponse.cs | 19 +- ...gCreateAccountResponseAccountingAccount.cs | 32 +- ...CreateAccountResponseValidDataTypeLinks.cs | 30 +- .../AccountingCreateBankAccountResponse.cs | 19 +- ...ankAccountResponseAccountingBankAccount.cs | 24 +- ...AccountingCreateBankAccountTransactions.cs | 3 +- .../AccountingCreateBankTransactions.cs | 3 +- ...ccountingCreateBankTransactionsResponse.cs | 19 +- .../AccountingCreateDirectCostResponse.cs | 19 +- ...eDirectCostResponseAccountingDirectCost.cs | 22 +- .../AccountingCreatePaymentResponse.cs | 19 +- ...gCreatePaymentResponseAccountingPayment.cs | 526 +- .../AccountingCreateSupplierResponse.cs | 19 +- ...reateSupplierResponseAccountingSupplier.cs | 15 +- .../AccountingCreateTransferResponse.cs | 19 +- ...reateTransferResponseAccountingTransfer.cs | 13 +- .../AccountingCreateTransferResponseStatus.cs | 5 +- .../Models/Components/AccountingCreditNote.cs | 31 +- .../Components/AccountingCreditNotes.cs | 3 +- .../Models/Components/AccountingCustomer.cs | 15 +- .../Components/AccountingCustomerRef.cs | 7 +- .../Models/Components/AccountingCustomers.cs | 3 +- .../Models/Components/AccountingDirectCost.cs | 22 +- .../Components/AccountingDirectCosts.cs | 3 +- .../Components/AccountingDirectIncome.cs | 27 +- .../Components/AccountingDirectIncomes.cs | 3 +- .../Models/Components/AccountingInvoice.cs | 41 +- .../Components/AccountingInvoiceDataType.cs | 3 +- .../Models/Components/AccountingInvoices.cs | 3 +- .../Models/Components/AccountingJournal.cs | 22 +- .../Components/AccountingJournalEntries.cs | 3 +- .../Components/AccountingJournalEntry.cs | 28 +- .../Models/Components/AccountingJournals.cs | 3 +- .../Models/Components/AccountingPayment.cs | 526 +- .../Components/AccountingPaymentAllocation.cs | 3 +- .../Models/Components/AccountingPayments.cs | 3 +- .../AccountingProfitAndLossReport.cs | 18 +- .../Models/Components/AccountingRecordRef.cs | 12 +- .../Models/Components/AccountingSupplier.cs | 15 +- .../Models/Components/AccountingSuppliers.cs | 3 +- .../Models/Components/AccountingTransfer.cs | 13 +- .../Components/AccountingTransferStatus.cs | 5 +- .../Models/Components/AccountingTransfers.cs | 3 +- .../Lending/Models/Components/Accounts.cs | 10 +- .../Components/AccountsPayableTracking.cs | 3 +- .../Components/AccountsReceivableTracking.cs | 8 +- .../Lending/Models/Components/AgedCreditor.cs | 3 +- .../Components/AgedCurrencyOutstanding.cs | 6 +- .../Lending/Models/Components/AgedDebtor.cs | 3 +- .../Components/AgedOutstandingAmount.cs | 13 +- .../Components/AgedOutstandingAmountDetail.cs | 3 +- .../Lending/Models/Components/Allocation.cs | 16 +- .../Lending/Models/Components/Attachments.cs | 3 +- .../Lending/Models/Components/BalanceSheet.cs | 8 +- .../Models/Components/BankAccountRef.cs | 7 +- .../Models/Components/BankAccountStatus.cs | 3 +- .../Components/BankFeedBankAccountMapping.cs | 12 +- .../BankFeedBankAccountMappingResponse.cs | 5 +- .../Models/Components/BankFeedMapping.cs | 11 +- .../BankStatementUploadConfiguration.cs | 11 +- .../Models/Components/BankTransactionType.cs | 3 +- .../Models/Components/BankingAccount.cs | 11 +- .../Components/BankingAccountBalance.cs | 11 +- .../Components/BankingAccountBalances.cs | 3 +- .../Models/Components/BankingAccounts.cs | 3 +- .../Models/Components/BankingTransaction.cs | 16 +- .../BankingTransactionCategories.cs | 3 +- .../Components/BankingTransactionCategory.cs | 6 +- .../Components/BankingTransactionRef.cs | 12 +- .../Models/Components/BankingTransactions.cs | 3 +- .../Components/BillCreditNoteLineItem.cs | 15 +- .../Models/Components/BillCreditNoteStatus.cs | 5 +- .../Lending/Models/Components/BillLineItem.cs | 15 +- .../Models/Components/BillLineItemDataType.cs | 5 +- .../Models/Components/BillPaymentLine.cs | 8 +- .../Models/Components/BillPaymentLineLink.cs | 11 +- .../Components/BillPaymentLineLinkType.cs | 3 +- .../Lending/Models/Components/BillStatus.cs | 3 +- .../Lending/Models/Components/BilledToType.cs | 3 +- .../Models/Components/BilledToType1.cs | 3 +- .../Models/Components/CashFlowStatement.cs | 13 +- .../Models/Components/CashFlowTransaction.cs | 24 +- .../Components/ClientRateLimitWebhook.cs | 8 +- .../ClientRateLimitWebhookPayload.cs | 8 +- .../Lending/Models/Components/CodatFile.cs | 3 +- .../Models/Components/CommerceAddress.cs | 17 +- .../Models/Components/CommerceAddressType.cs | 5 +- .../Models/Components/CommerceCompanyInfo.cs | 35 +- .../Models/Components/CommerceCustomer.cs | 18 +- .../Models/Components/CommerceCustomerRef.cs | 5 +- .../Models/Components/CommerceCustomers.cs | 3 +- .../Models/Components/CommerceDispute.cs | 33 +- .../Models/Components/CommerceDisputes.cs | 3 +- .../Models/Components/CommerceLocation.cs | 10 +- .../Models/Components/CommerceLocations.cs | 3 +- .../Models/Components/CommerceOrder.cs | 29 +- .../Models/Components/CommerceOrders.cs | 3 +- .../Models/Components/CommercePayment.cs | 26 +- .../Components/CommercePaymentMethod.cs | 7 +- .../Components/CommercePaymentMethodStatus.cs | 3 +- .../Components/CommercePaymentMethods.cs | 3 +- .../Models/Components/CommercePayments.cs | 3 +- .../Models/Components/CommerceProduct.cs | 22 +- .../Components/CommerceProductCategories.cs | 3 +- .../Components/CommerceProductCategory.cs | 9 +- .../Models/Components/CommerceProducts.cs | 3 +- .../Models/Components/CommerceRecordRef.cs | 5 +- .../Models/Components/CommerceReport.cs | 12 +- .../Components/CommerceReportComponent.cs | 11 +- .../Components/CommerceReportDimension.cs | 9 +- .../CommerceReportDimensionItems.cs | 5 +- .../Models/Components/CommerceReportError.cs | 3 +- .../Components/CommerceReportMeasure.cs | 11 +- .../Models/Components/CommerceTransaction.cs | 47 +- .../Models/Components/CommerceTransactions.cs | 3 +- .../Lending/Models/Components/Companies.cs | 3 +- .../Lending/Models/Components/Company.cs | 18 +- .../Models/Components/CompanyReference.cs | 5 +- .../Components/CompanyReferenceLinks.cs | 3 +- .../Models/Components/CompanyRequestBody.cs | 3 +- .../Models/Components/CompanyUpdateRequest.cs | 3 +- .../Lending/Models/Components/Connection.cs | 22 +- .../Lending/Models/Components/Connections.cs | 3 +- .../Lending/Models/Components/Contact.cs | 8 +- .../Lending/Models/Components/ContactRef.cs | 5 +- .../Models/Components/ContactRefDataType.cs | 5 +- .../Models/Components/ContactReference.cs | 5 +- .../CreateBankAccountTransaction.cs | 8 +- .../Models/Components/CreditNoteLineItem.cs | 8 +- .../Models/Components/CreditNoteStatus.cs | 3 +- .../Models/Components/CustomerStatus.cs | 3 +- .../Models/Components/DataConnectionError.cs | 13 +- .../Models/Components/DataConnectionStatus.cs | 3 +- .../Models/Components/DataIntegrityAmounts.cs | 6 +- .../Components/DataIntegrityByAmount.cs | 8 +- .../Models/Components/DataIntegrityByCount.cs | 5 +- .../Components/DataIntegrityConnectionId.cs | 3 +- .../Components/DataIntegrityDataType.cs | 3 +- .../Models/Components/DataIntegrityDates.cs | 23 +- .../Models/Components/DataIntegrityDetail.cs | 11 +- .../Models/Components/DataIntegrityDetails.cs | 3 +- .../Models/Components/DataIntegrityMatch.cs | 8 +- .../Models/Components/DataIntegrityStatus.cs | 5 +- .../Components/DataIntegrityStatusInfo.cs | 8 +- .../Components/DataIntegrityStatuses.cs | 3 +- .../Components/DataIntegritySummaries.cs | 3 +- .../Models/Components/DataIntegritySummary.cs | 5 +- .../Lending/Models/Components/DataSource.cs | 3 +- .../Lending/Models/Components/DataStatus.cs | 12 +- .../Lending/Models/Components/DataType.cs | 5 +- .../Lending/Models/Components/DataTypes.cs | 5 +- .../Models/Components/DatasetStatus.cs | 3 +- .../Models/Components/DirectCostLineItem.cs | 14 +- .../Models/Components/DirectCostPrototype.cs | 19 +- .../Models/Components/DirectIncomeLineItem.cs | 17 +- .../Models/Components/DisputeStatus.cs | 5 +- .../Components/EndUploadSessionRequest.cs | 3 +- .../EndUploadSessionRequestStatus.cs | 3 +- .../Models/Components/EnhancedCashFlowItem.cs | 3 +- .../EnhancedCashFlowTransactions.cs | 8 +- .../Components/EnhancedFinancialReport.cs | 3 +- .../Components/EnhancedInvoiceReportItem.cs | 32 +- .../Components/EnhancedInvoicesReport.cs | 3 +- .../EnhancedReportAccountCategory.cs | 5 +- .../Models/Components/EnhancedReportInfo.cs | 11 +- .../Lending/Models/Components/ErrorStatus.cs | 3 +- .../Models/Components/ErrorValidation.cs | 3 +- .../Models/Components/ErrorValidationItem.cs | 5 +- .../Models/Components/ExcelReportTypes.cs | 3 +- .../Lending/Models/Components/ExcelStatus.cs | 8 +- .../Codat/Lending/Models/Components/File.cs | 10 +- .../Lending/Models/Components/FileUpload.cs | 3 +- .../Codat/Lending/Models/Components/HalRef.cs | 3 +- .../Models/Components/IntegrityStatus.cs | 3 +- .../Models/Components/InvoiceLineItem.cs | 8 +- .../Models/Components/InvoiceStatus.cs | 10 +- .../Lending/Models/Components/ItemRef.cs | 3 +- .../Models/Components/ItemReference.cs | 3 +- .../Codat/Lending/Models/Components/Items.cs | 3 +- .../Components/JournalEntryRecordRef.cs | 5 +- .../JournalEntryRecordRefDataType.cs | 3 +- .../Lending/Models/Components/JournalLine.cs | 5 +- .../Models/Components/JournalLineDataType.cs | 5 +- .../Models/Components/JournalLineTracking.cs | 5 +- .../Lending/Models/Components/JournalRef.cs | 5 +- .../Models/Components/JournalStatus.cs | 3 +- .../Models/Components/LendingCustomerRef.cs | 3 +- .../Codat/Lending/Models/Components/Links.cs | 3 +- .../Lending/Models/Components/LoanRef.cs | 3 +- .../Lending/Models/Components/LoanSummary.cs | 5 +- .../Components/LoanSummaryIntegrationType.cs | 3 +- .../Models/Components/LoanSummaryRecordRef.cs | 3 +- .../Components/LoanSummaryRecordRefType.cs | 3 +- .../Components/LoanSummaryReportInfo.cs | 8 +- .../Components/LoanSummaryReportItem.cs | 8 +- .../Models/Components/LoanTransactionType.cs | 3 +- .../Models/Components/LoanTransactions.cs | 3 +- .../Components/LoanTransactionsReportInfo.cs | 8 +- .../Lending/Models/Components/LocationRef.cs | 3 +- .../Lending/Models/Components/Metadata.cs | 3 +- .../Components/OrderDiscountAllocation.cs | 3 +- .../Models/Components/OrderLineItem.cs | 11 +- .../Codat/Lending/Models/Components/Path.cs | 3 +- .../Lending/Models/Components/Payment.cs | 16 +- .../Components/PaymentAllocationPayment.cs | 16 +- .../Lending/Models/Components/PaymentLine.cs | 8 +- .../Models/Components/PaymentLineLink.cs | 16 +- .../Models/Components/PaymentLinkType.cs | 8 +- .../Models/Components/PaymentMethodRef.cs | 3 +- .../Lending/Models/Components/PaymentRef.cs | 18 +- .../Models/Components/PaymentStatus.cs | 3 +- .../Lending/Models/Components/PaymentType.cs | 3 +- .../Lending/Models/Components/PeriodUnit.cs | 3 +- .../Lending/Models/Components/PhoneNumber.cs | 5 +- .../Models/Components/ProductInventory.cs | 3 +- .../Components/ProductInventoryLocation.cs | 3 +- .../Lending/Models/Components/ProductPrice.cs | 8 +- .../Lending/Models/Components/ProductRef.cs | 3 +- .../Models/Components/ProductVariant.cs | 16 +- .../Models/Components/ProductVariantRef.cs | 3 +- .../Models/Components/ProductVariantStatus.cs | 3 +- .../Models/Components/ProfitAndLossReport.cs | 13 +- .../Lending/Models/Components/ProjectRef.cs | 5 +- .../Models/Components/PropertieAccountType.cs | 3 +- .../Models/Components/PropertieDataType.cs | 5 +- .../Models/Components/PropertieItemRef.cs | 3 +- .../Models/Components/PullOperation.cs | 16 +- .../Models/Components/PullOperations.cs | 3 +- .../Components/PurchaseOrderReference.cs | 3 +- .../Models/Components/PushChangeType.cs | 3 +- .../Models/Components/PushFieldValidation.cs | 3 +- .../Models/Components/PushOperation.cs | 19 +- .../Models/Components/PushOperationChange.cs | 3 +- .../Models/Components/PushOperationRef.cs | 5 +- .../Models/Components/PushOperationStatus.cs | 3 +- .../Models/Components/PushOperations.cs | 3 +- .../Lending/Models/Components/PushOption.cs | 5 +- .../Models/Components/PushOptionChoice.cs | 5 +- .../Models/Components/PushOptionProperty.cs | 5 +- .../Models/Components/PushOptionType.cs | 3 +- .../Models/Components/PushValidationInfo.cs | 3 +- .../Models/Components/RecordLineReference.cs | 7 +- .../Lending/Models/Components/ReportBasis.cs | 3 +- .../Components/ReportComponentMeasure.cs | 9 +- .../Components/ReportGenerationPayload.cs | 3 +- .../Lending/Models/Components/ReportInfo.cs | 3 +- .../Lending/Models/Components/ReportInput.cs | 3 +- .../Lending/Models/Components/ReportItem.cs | 8 +- .../Lending/Models/Components/ReportItems.cs | 8 +- .../Lending/Models/Components/ReportLine.cs | 3 +- .../Models/Components/ReportOperation.cs | 15 +- .../Components/ReportOperationStatus.cs | 3 +- .../Models/Components/ReportOperationType.cs | 3 +- .../Components/ReportSourceReference.cs | 5 +- .../Lending/Models/Components/ReportType.cs | 3 +- .../Lending/Models/Components/Reports.cs | 3 +- .../Lending/Models/Components/RoutingInfo.cs | 5 +- .../Models/Components/RoutingInfoType.cs | 3 +- .../Models/Components/SalesOrderReference.cs | 3 +- .../Codat/Lending/Models/Components/Schema.cs | 8 +- .../Lending/Models/Components/Security.cs | 3 +- .../Models/Components/ServiceCharge.cs | 3 +- .../Models/Components/ServiceChargeType.cs | 3 +- .../Codat/Lending/Models/Components/Source.cs | 5 +- .../Models/Components/SourceAccount.cs | 16 +- .../Components/SourceAccountPrototype.cs | 11 +- .../Models/Components/SourceAccountStatus.cs | 3 +- .../Models/Components/SourceAccountV2.cs | 16 +- .../Components/SourceAccountV2AccountType.cs | 3 +- .../Components/SourceAccountV2Prototype.cs | 11 +- .../Components/SourceAccountV2Status.cs | 3 +- .../Lending/Models/Components/SourceRef.cs | 5 +- .../Lending/Models/Components/SourceType.cs | 3 +- .../Components/StartUploadSessionRequest.cs | 3 +- .../StartUploadSessionRequestDataType.cs | 3 +- .../Codat/Lending/Models/Components/Status.cs | 3 +- .../Models/Components/SupplementalData.cs | 6 +- .../Lending/Models/Components/SupplierRef.cs | 7 +- .../Models/Components/SupplierStatus.cs | 3 +- .../Models/Components/TargetAccountOption.cs | 3 +- .../Components/TaxComponentAllocation.cs | 3 +- .../Models/Components/TaxComponentRef.cs | 3 +- .../Lending/Models/Components/TaxRateRef.cs | 8 +- .../Models/Components/TaxRateReference.cs | 8 +- .../Lending/Models/Components/Tracking.cs | 8 +- .../Models/Components/TrackingCategoryRef.cs | 3 +- .../Models/Components/TrackingRecordRef.cs | 5 +- .../Components/TrackingRecordRefDataType.cs | 3 +- .../Models/Components/TransactionCategory.cs | 3 +- .../Components/TransactionCategoryRef.cs | 3 +- .../Components/TransactionCategoryStatus.cs | 3 +- .../Models/Components/TransactionCode.cs | 3 +- .../Models/Components/TransactionSourceRef.cs | 5 +- .../Components/TransactionSourceType.cs | 3 +- .../Models/Components/TransactionType.cs | 18 +- .../Models/Components/TransferAccount.cs | 11 +- .../Codat/Lending/Models/Components/Type.cs | 5 +- .../Models/Components/ValidDataTypeLinks.cs | 30 +- .../Lending/Models/Components/Validation.cs | 3 +- .../Models/Components/ValidationItem.cs | 5 +- .../Lending/Models/Components/WebLink.cs | 3 +- .../Lending/Models/Components/WebLinkType.cs | 3 +- .../Models/Components/WithholdingTax.cs | 3 +- .../Codat/Lending/Models/Components/Zero.cs | 12 +- .../Lending/Models/Components/ZeroDataType.cs | 5 +- .../Models/Errors/CodatLendingException.cs | 3 + .../Lending/Models/Errors/ErrorMessage.cs | 5 +- .../Lending/Models/Errors/SDKException.cs | 3 + .../Models/Requests/CreateAccountRequest.cs | 3 +- .../Models/Requests/CreateAccountResponse.cs | 11 +- .../CreateBankAccountMappingRequest.cs | 3 +- .../CreateBankAccountMappingResponse.cs | 11 +- .../Requests/CreateBankAccountRequest.cs | 3 +- .../Requests/CreateBankAccountResponse.cs | 11 +- .../Requests/CreateBankTransactionsRequest.cs | 3 +- .../CreateBankTransactionsResponse.cs | 11 +- .../Models/Requests/CreateCompanyResponse.cs | 11 +- .../Requests/CreateConnectionRequest.cs | 3 +- .../Requests/CreateConnectionRequestBody.cs | 3 +- .../Requests/CreateConnectionResponse.cs | 11 +- .../Requests/CreateDirectCostRequest.cs | 3 +- .../Requests/CreateDirectCostResponse.cs | 11 +- .../Models/Requests/CreatePaymentRequest.cs | 3 +- .../Models/Requests/CreatePaymentResponse.cs | 11 +- .../Requests/CreateSourceAccountRequest.cs | 3 +- .../CreateSourceAccountRequestBody.cs | 1 - .../Requests/CreateSourceAccountResponse.cs | 11 +- .../CreateSourceAccountResponseBody.cs | 3 +- .../Models/Requests/CreateSupplierRequest.cs | 3 +- .../Models/Requests/CreateSupplierResponse.cs | 11 +- .../Models/Requests/CreateTransferRequest.cs | 3 +- .../Models/Requests/CreateTransferResponse.cs | 11 +- .../Models/Requests/DeleteCompanyRequest.cs | 3 +- .../Models/Requests/DeleteCompanyResponse.cs | 9 +- .../Requests/DeleteConnectionRequest.cs | 3 +- .../Requests/DeleteConnectionResponse.cs | 9 +- ...DownloadAccountingBillAttachmentRequest.cs | 3 +- ...ownloadAccountingBillAttachmentResponse.cs | 11 +- ...loadAccountingCustomerAttachmentRequest.cs | 3 +- ...oadAccountingCustomerAttachmentResponse.cs | 11 +- ...adAccountingDirectCostAttachmentRequest.cs | 3 +- ...dAccountingDirectCostAttachmentResponse.cs | 11 +- ...AccountingDirectIncomeAttachmentRequest.cs | 3 +- ...ccountingDirectIncomeAttachmentResponse.cs | 11 +- ...nloadAccountingInvoiceAttachmentRequest.cs | 3 +- ...loadAccountingInvoiceAttachmentResponse.cs | 11 +- .../DownloadAccountingInvoicePdfRequest.cs | 3 +- .../DownloadAccountingInvoicePdfResponse.cs | 11 +- ...loadAccountingSupplierAttachmentRequest.cs | 3 +- ...oadAccountingSupplierAttachmentResponse.cs | 11 +- .../Requests/DownloadExcelReportRequest.cs | 3 +- .../Requests/DownloadExcelReportResponse.cs | 9 +- .../Models/Requests/DownloadFilesRequest.cs | 3 +- .../Models/Requests/DownloadFilesResponse.cs | 11 +- .../EndBankStatementUploadSessionRequest.cs | 3 +- .../EndBankStatementUploadSessionResponse.cs | 9 +- .../Requests/GenerateExcelReportRequest.cs | 3 +- .../Requests/GenerateExcelReportResponse.cs | 11 +- ...GenerateLoanSummaryQueryParamSourceType.cs | 3 +- .../Requests/GenerateLoanSummaryRequest.cs | 3 +- .../Requests/GenerateLoanSummaryResponse.cs | 9 +- .../GenerateLoanTransactionsRequest.cs | 3 +- .../GenerateLoanTransactionsResponse.cs | 9 +- .../Models/Requests/GenerateReportRequest.cs | 5 +- .../Models/Requests/GenerateReportResponse.cs | 11 +- .../Requests/GetAccountingAccountRequest.cs | 3 +- .../Requests/GetAccountingAccountResponse.cs | 11 +- .../GetAccountingAccountTransactionRequest.cs | 3 +- ...GetAccountingAccountTransactionResponse.cs | 11 +- ...GetAccountingAgedCreditorsReportRequest.cs | 3 +- ...etAccountingAgedCreditorsReportResponse.cs | 11 +- .../GetAccountingAgedDebtorsReportRequest.cs | 3 +- .../GetAccountingAgedDebtorsReportResponse.cs | 11 +- .../GetAccountingBalanceSheetRequest.cs | 3 +- .../GetAccountingBalanceSheetResponse.cs | 11 +- .../GetAccountingBankAccountRequest.cs | 3 +- .../GetAccountingBankAccountResponse.cs | 11 +- .../GetAccountingBillAttachmentRequest.cs | 3 +- .../GetAccountingBillAttachmentResponse.cs | 11 +- .../GetAccountingBillCreditNoteRequest.cs | 3 +- .../GetAccountingBillCreditNoteResponse.cs | 11 +- .../GetAccountingBillPaymentRequest.cs | 3 +- .../GetAccountingBillPaymentResponse.cs | 11 +- .../Requests/GetAccountingBillRequest.cs | 3 +- .../Requests/GetAccountingBillResponse.cs | 11 +- .../GetAccountingCashFlowStatementRequest.cs | 3 +- .../GetAccountingCashFlowStatementResponse.cs | 11 +- .../GetAccountingCreditNoteRequest.cs | 3 +- .../GetAccountingCreditNoteResponse.cs | 11 +- .../GetAccountingCustomerAttachmentRequest.cs | 3 +- ...GetAccountingCustomerAttachmentResponse.cs | 11 +- .../Requests/GetAccountingCustomerRequest.cs | 3 +- .../Requests/GetAccountingCustomerResponse.cs | 11 +- ...etAccountingDirectCostAttachmentRequest.cs | 3 +- ...tAccountingDirectCostAttachmentResponse.cs | 11 +- .../GetAccountingDirectCostRequest.cs | 3 +- .../GetAccountingDirectCostResponse.cs | 11 +- ...AccountingDirectIncomeAttachmentRequest.cs | 3 +- ...ccountingDirectIncomeAttachmentResponse.cs | 11 +- .../GetAccountingDirectIncomeRequest.cs | 3 +- .../GetAccountingDirectIncomeResponse.cs | 11 +- .../GetAccountingInvoiceAttachmentRequest.cs | 3 +- .../GetAccountingInvoiceAttachmentResponse.cs | 11 +- .../Requests/GetAccountingInvoiceRequest.cs | 3 +- .../Requests/GetAccountingInvoiceResponse.cs | 11 +- .../GetAccountingJournalEntryRequest.cs | 3 +- .../GetAccountingJournalEntryResponse.cs | 11 +- .../Requests/GetAccountingJournalRequest.cs | 3 +- .../Requests/GetAccountingJournalResponse.cs | 11 +- .../Requests/GetAccountingPaymentRequest.cs | 3 +- .../Requests/GetAccountingPaymentResponse.cs | 11 +- .../Requests/GetAccountingProfileRequest.cs | 3 +- .../Requests/GetAccountingProfileResponse.cs | 11 +- .../GetAccountingProfitAndLossRequest.cs | 3 +- .../GetAccountingProfitAndLossResponse.cs | 11 +- .../GetAccountingSupplierAttachmentRequest.cs | 3 +- ...GetAccountingSupplierAttachmentResponse.cs | 11 +- .../Requests/GetAccountingSupplierRequest.cs | 3 +- .../Requests/GetAccountingSupplierResponse.cs | 11 +- .../Requests/GetAccountingTransferRequest.cs | 3 +- .../Requests/GetAccountingTransferResponse.cs | 11 +- .../Requests/GetBankAccountMappingRequest.cs | 3 +- .../Requests/GetBankAccountMappingResponse.cs | 11 +- ...BankStatementUploadConfigurationRequest.cs | 3 +- ...ankStatementUploadConfigurationResponse.cs | 11 +- .../Requests/GetBankingAccountRequest.cs | 3 +- .../Requests/GetBankingAccountResponse.cs | 11 +- .../GetBankingTransactionCategoryRequest.cs | 5 +- .../GetBankingTransactionCategoryResponse.cs | 11 +- .../Requests/GetBankingTransactionRequest.cs | 5 +- .../Requests/GetBankingTransactionResponse.cs | 11 +- ...CategorizedBalanceSheetStatementRequest.cs | 3 +- ...ategorizedBalanceSheetStatementResponse.cs | 11 +- .../GetCategorizedBankStatementRequest.cs | 3 +- .../GetCategorizedBankStatementResponse.cs | 11 +- ...ategorizedProfitAndLossStatementRequest.cs | 3 +- ...tegorizedProfitAndLossStatementResponse.cs | 11 +- .../Requests/GetCommerceCustomerRequest.cs | 3 +- .../Requests/GetCommerceCustomerResponse.cs | 11 +- ...CommerceCustomerRetentionMetricsRequest.cs | 3 +- ...ommerceCustomerRetentionMetricsResponse.cs | 11 +- .../Requests/GetCommerceDisputeRequest.cs | 3 +- .../Requests/GetCommerceDisputeResponse.cs | 11 +- .../GetCommerceLifetimeValueMetricsRequest.cs | 3 +- ...GetCommerceLifetimeValueMetricsResponse.cs | 11 +- .../Requests/GetCommerceLocationRequest.cs | 3 +- .../Requests/GetCommerceLocationResponse.cs | 11 +- .../Requests/GetCommerceOrderRequest.cs | 3 +- .../Requests/GetCommerceOrderResponse.cs | 11 +- .../GetCommerceOrdersReportRequest.cs | 3 +- .../GetCommerceOrdersReportResponse.cs | 11 +- .../GetCommercePaymentMethodRequest.cs | 3 +- .../GetCommercePaymentMethodResponse.cs | 11 +- .../Requests/GetCommercePaymentRequest.cs | 3 +- .../Requests/GetCommercePaymentResponse.cs | 11 +- .../GetCommerceProductCategoryRequest.cs | 3 +- .../GetCommerceProductCategoryResponse.cs | 11 +- .../Requests/GetCommerceProductRequest.cs | 3 +- .../Requests/GetCommerceProductResponse.cs | 11 +- .../Requests/GetCommerceProfileRequest.cs | 3 +- .../Requests/GetCommerceProfileResponse.cs | 11 +- .../GetCommerceRefundsReportRequest.cs | 3 +- .../GetCommerceRefundsReportResponse.cs | 11 +- .../GetCommerceRevenueMetricsRequest.cs | 3 +- .../GetCommerceRevenueMetricsResponse.cs | 11 +- .../Requests/GetCommerceTransactionRequest.cs | 3 +- .../GetCommerceTransactionResponse.cs | 11 +- .../Models/Requests/GetCompanyRequest.cs | 3 +- .../Models/Requests/GetCompanyResponse.cs | 11 +- .../Models/Requests/GetConnectionRequest.cs | 3 +- .../Models/Requests/GetConnectionResponse.cs | 11 +- .../GetCreateBankTransactionsModelRequest.cs | 3 +- .../GetCreateBankTransactionsModelResponse.cs | 11 +- .../GetCreateChartOfAccountsModelRequest.cs | 3 +- .../GetCreateChartOfAccountsModelResponse.cs | 11 +- .../GetCreateDirectCostsModelRequest.cs | 3 +- .../GetCreateDirectCostsModelResponse.cs | 11 +- .../Requests/GetCreateOperationRequest.cs | 3 +- .../Requests/GetCreateOperationResponse.cs | 11 +- .../Requests/GetCreatePaymentModelRequest.cs | 3 +- .../Requests/GetCreatePaymentModelResponse.cs | 11 +- .../GetCreateTransfersModelRequest.cs | 3 +- .../GetCreateTransfersModelResponse.cs | 11 +- ...GetCreateUpdateBankAccountsModelRequest.cs | 3 +- ...etCreateUpdateBankAccountsModelResponse.cs | 11 +- .../GetCreateUpdateSuppliersModelRequest.cs | 3 +- .../GetCreateUpdateSuppliersModelResponse.cs | 11 +- .../Requests/GetDataIntegrityStatusRequest.cs | 3 +- .../GetDataIntegrityStatusResponse.cs | 11 +- .../GetDataIntegritySummariesRequest.cs | 3 +- .../GetDataIntegritySummariesResponse.cs | 11 +- .../Requests/GetDataStatusDataStatuses.cs | 91 +- .../Models/Requests/GetDataStatusRequest.cs | 3 +- .../Models/Requests/GetDataStatusResponse.cs | 11 +- .../GetExcelReportGenerationStatusRequest.cs | 3 +- .../GetExcelReportGenerationStatusResponse.cs | 11 +- .../GetLoanSummaryQueryParamSourceType.cs | 3 +- .../Models/Requests/GetLoanSummaryRequest.cs | 3 +- .../Models/Requests/GetLoanSummaryResponse.cs | 11 +- .../Requests/GetPullOperationRequest.cs | 3 +- .../Requests/GetPullOperationResponse.cs | 11 +- .../IsAgedCreditorsReportAvailableRequest.cs | 3 +- .../IsAgedCreditorsReportAvailableResponse.cs | 11 +- .../IsAgedDebtorsReportAvailableRequest.cs | 3 +- .../IsAgedDebtorsReportAvailableResponse.cs | 11 +- ...istAccountingAccountTransactionsRequest.cs | 3 +- ...stAccountingAccountTransactionsResponse.cs | 11 +- .../Requests/ListAccountingAccountsRequest.cs | 3 +- .../ListAccountingAccountsResponse.cs | 11 +- ...ccountingBankAccountTransactionsRequest.cs | 3 +- ...countingBankAccountTransactionsResponse.cs | 11 +- .../ListAccountingBankAccountsRequest.cs | 3 +- .../ListAccountingBankAccountsResponse.cs | 11 +- .../ListAccountingBillAttachmentsRequest.cs | 3 +- .../ListAccountingBillAttachmentsResponse.cs | 11 +- .../ListAccountingBillCreditNotesRequest.cs | 3 +- .../ListAccountingBillCreditNotesResponse.cs | 11 +- .../ListAccountingBillPaymentsRequest.cs | 3 +- .../ListAccountingBillPaymentsResponse.cs | 11 +- .../Requests/ListAccountingBillsRequest.cs | 3 +- .../Requests/ListAccountingBillsResponse.cs | 11 +- .../ListAccountingCreditNotesRequest.cs | 3 +- .../ListAccountingCreditNotesResponse.cs | 11 +- ...istAccountingCustomerAttachmentsRequest.cs | 3 +- ...stAccountingCustomerAttachmentsResponse.cs | 11 +- .../ListAccountingCustomersRequest.cs | 3 +- .../ListAccountingCustomersResponse.cs | 11 +- ...tAccountingDirectCostAttachmentsRequest.cs | 3 +- ...AccountingDirectCostAttachmentsResponse.cs | 11 +- .../ListAccountingDirectCostsRequest.cs | 3 +- .../ListAccountingDirectCostsResponse.cs | 11 +- ...ccountingDirectIncomeAttachmentsRequest.cs | 3 +- ...countingDirectIncomeAttachmentsResponse.cs | 11 +- .../ListAccountingDirectIncomesRequest.cs | 3 +- .../ListAccountingDirectIncomesResponse.cs | 11 +- ...ListAccountingInvoiceAttachmentsRequest.cs | 3 +- ...istAccountingInvoiceAttachmentsResponse.cs | 11 +- .../Requests/ListAccountingInvoicesRequest.cs | 3 +- .../ListAccountingInvoicesResponse.cs | 11 +- .../ListAccountingJournalEntriesRequest.cs | 3 +- .../ListAccountingJournalEntriesResponse.cs | 11 +- .../Requests/ListAccountingJournalsRequest.cs | 3 +- .../ListAccountingJournalsResponse.cs | 11 +- .../Requests/ListAccountingPaymentsRequest.cs | 3 +- .../ListAccountingPaymentsResponse.cs | 11 +- ...istAccountingSupplierAttachmentsRequest.cs | 3 +- ...stAccountingSupplierAttachmentsResponse.cs | 11 +- .../ListAccountingSuppliersRequest.cs | 3 +- .../ListAccountingSuppliersResponse.cs | 11 +- .../ListAccountingTransfersRequest.cs | 3 +- .../ListAccountingTransfersResponse.cs | 11 +- .../ListBankingAccountBalancesRequest.cs | 3 +- .../ListBankingAccountBalancesResponse.cs | 11 +- .../Requests/ListBankingAccountsRequest.cs | 3 +- .../Requests/ListBankingAccountsResponse.cs | 11 +- ...ListBankingTransactionCategoriesRequest.cs | 3 +- ...istBankingTransactionCategoriesResponse.cs | 11 +- .../ListBankingTransactionsRequest.cs | 3 +- .../ListBankingTransactionsResponse.cs | 11 +- .../Requests/ListCommerceCustomersRequest.cs | 3 +- .../Requests/ListCommerceCustomersResponse.cs | 11 +- .../Requests/ListCommerceDisputesRequest.cs | 3 +- .../Requests/ListCommerceDisputesResponse.cs | 11 +- .../Requests/ListCommerceLocationsRequest.cs | 3 +- .../Requests/ListCommerceLocationsResponse.cs | 11 +- .../Requests/ListCommerceOrdersRequest.cs | 3 +- .../Requests/ListCommerceOrdersResponse.cs | 11 +- .../ListCommercePaymentMethodsRequest.cs | 3 +- .../ListCommercePaymentMethodsResponse.cs | 11 +- .../Requests/ListCommercePaymentsRequest.cs | 3 +- .../Requests/ListCommercePaymentsResponse.cs | 11 +- .../ListCommerceProductCategoriesRequest.cs | 3 +- .../ListCommerceProductCategoriesResponse.cs | 11 +- .../Requests/ListCommerceProductsRequest.cs | 3 +- .../Requests/ListCommerceProductsResponse.cs | 11 +- .../ListCommerceTransactionsRequest.cs | 3 +- .../ListCommerceTransactionsResponse.cs | 11 +- .../Models/Requests/ListCompaniesRequest.cs | 5 +- .../Models/Requests/ListCompaniesResponse.cs | 11 +- .../Models/Requests/ListConnectionsRequest.cs | 3 +- .../Requests/ListConnectionsResponse.cs | 11 +- .../Requests/ListCreateOperationsRequest.cs | 3 +- .../Requests/ListCreateOperationsResponse.cs | 11 +- .../ListDataIntegrityDetailsRequest.cs | 3 +- .../ListDataIntegrityDetailsResponse.cs | 11 +- .../Models/Requests/ListFilesRequest.cs | 3 +- .../Models/Requests/ListFilesResponse.cs | 11 +- .../Requests/ListLoanTransactionsRequest.cs | 3 +- .../Requests/ListLoanTransactionsResponse.cs | 11 +- .../Requests/ListPullOperationsRequest.cs | 3 +- .../Requests/ListPullOperationsResponse.cs | 11 +- .../Requests/ListReconciledInvoicesRequest.cs | 3 +- .../ListReconciledInvoicesResponse.cs | 11 +- .../Models/Requests/ListReportsRequest.cs | 3 +- .../Models/Requests/ListReportsResponse.cs | 11 +- .../Models/Requests/QueryParamSourceType.cs | 3 +- .../Requests/RefreshAllDataTypesRequest.cs | 3 +- .../Requests/RefreshAllDataTypesResponse.cs | 9 +- .../Models/Requests/RefreshDataTypeRequest.cs | 3 +- .../Requests/RefreshDataTypeResponse.cs | 11 +- .../Models/Requests/ReplaceCompanyRequest.cs | 3 +- .../Models/Requests/ReplaceCompanyResponse.cs | 11 +- ...BankStatementUploadConfigurationRequest.cs | 3 +- ...ankStatementUploadConfigurationResponse.cs | 11 +- .../Lending/Models/Requests/SourceType.cs | 3 +- .../StartBankStatementUploadSessionRequest.cs | 3 +- ...StartBankStatementUploadSessionResponse.cs | 11 +- .../Requests/UnlinkConnectionRequest.cs | 3 +- .../Requests/UnlinkConnectionResponse.cs | 11 +- .../UnlinkConnectionUpdateConnection.cs | 3 +- .../Models/Requests/UpdateCompanyRequest.cs | 3 +- .../Models/Requests/UpdateCompanyResponse.cs | 11 +- .../UploadBankStatementDataRequest.cs | 3 +- .../UploadBankStatementDataRequestBody.cs | 1 - .../UploadBankStatementDataResponse.cs | 9 +- .../Models/Requests/UploadFilesRequest.cs | 3 +- .../Models/Requests/UploadFilesResponse.cs | 9 +- .../AccountCategoriesUpdatedResponse.cs | 9 +- .../ClientRateLimitReachedResponse.cs | 9 +- .../Webhooks/ClientRateLimitResetResponse.cs | 9 +- ...BankStatementGenerateSuccessfulResponse.cs | 9 +- ...nkStatementGenerateUnsuccessfulResponse.cs | 9 +- ...nerateSuccessfulReportGenerationWebhook.cs | 8 +- ...tsCreditModelGenerateSuccessfulResponse.cs | 9 +- ...CreditModelGenerateUnsuccessfulResponse.cs | 9 +- lending/Codat/Lending/Orders.cs | 103 +- lending/Codat/Lending/PaymentMethods.cs | 106 +- lending/Codat/Lending/Payments.cs | 106 +- lending/Codat/Lending/ProductCategories.cs | 110 +- lending/Codat/Lending/Products.cs | 110 +- lending/Codat/Lending/ProfitAndLoss.cs | 92 +- lending/Codat/Lending/PullOperations.cs | 87 +- lending/Codat/Lending/Refresh.cs | 96 +- lending/Codat/Lending/Reports.cs | 149 +- lending/Codat/Lending/SDKConfig.cs | 7 +- lending/Codat/Lending/Sales.cs | 72 +- lending/Codat/Lending/SourceAccounts.cs | 176 +- lending/Codat/Lending/Suppliers.cs | 241 +- .../Codat/Lending/TransactionCategories.cs | 106 +- lending/Codat/Lending/Transactions.cs | 36 +- lending/Codat/Lending/Transfers.cs | 106 +- lending/Codat/Lending/Utils/Constants.cs | 4 +- .../Lending/Utils/Retries/BackoffStrategy.cs | 3 + .../Codat/Lending/Utils/Retries/Retries.cs | 21 + .../Lending/Utils/Retries/RetryConfig.cs | 11 + lending/Codat/Lending/Utils/Utilities.cs | 16 + lending/RELEASES.md | 12 +- .../Models/Components/CashFlowTransaction.md | 3 +- lending/docs/sdks/bankstatements/README.md | 26 +- 751 files changed, 181675 insertions(+), 7011 deletions(-) create mode 100644 .speakeasy/logs/changes/changes.html create mode 100644 .speakeasy/logs/changes/changes.md create mode 100644 .speakeasy/logs/changes/new.openapi.yaml create mode 100644 .speakeasy/logs/changes/old.openapi.yaml diff --git a/.speakeasy/logs/changes/changes.html b/.speakeasy/logs/changes/changes.html new file mode 100644 index 000000000..3d3581f4d --- /dev/null +++ b/.speakeasy/logs/changes/changes.html @@ -0,0 +1,104 @@ + + + + + + + SDK Changelog - csharp + + +

Csharp SDK Changes:

+ + + + \ No newline at end of file diff --git a/.speakeasy/logs/changes/changes.md b/.speakeasy/logs/changes/changes.md new file mode 100644 index 000000000..cc237eb3a --- /dev/null +++ b/.speakeasy/logs/changes/changes.md @@ -0,0 +1,2 @@ +## Csharp SDK Changes: +* `Codat.lending.Banking.CategorizedStatement.Get()`: `response.reportItems[].Transactions[].IsRecurring` **Added** diff --git a/.speakeasy/logs/changes/new.openapi.yaml b/.speakeasy/logs/changes/new.openapi.yaml new file mode 100644 index 000000000..dbf989a4c --- /dev/null +++ b/.speakeasy/logs/changes/new.openapi.yaml @@ -0,0 +1,86068 @@ +openapi: 3.1.0 +servers: + - description: Production + url: 'https://api.codat.io' +info: + title: Lending + description: |- + Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. + + The Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers. + + [Explore solution](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + + + ## Endpoints + + | Endpoints | Description | + | :- |:- | + | Companies | Create and manage your SMB users' companies. | + | Connections | Create new and manage existing data connections for a company. | + | Bank statements | Retrieve banking data from linked bank accounts. | + | Sales | Retrieve standardized sales data from a linked commerce software. | + | Financial statements | Financial data and reports from a linked accounting software. | + | Liabilities | Debt and other liabilities. | + | Accounts payable | Data from a linked accounting software representing money the business owes money to its suppliers. | + | Accounts receivable | Data from a linked accounting software representing money owed to the business for sold goods or services. | + | Transactions | Data from a linked accounting software representing transactions. | + | Company info | View company information fetched from the source platform. | + | Data integrity | Match mutable accounting data with immutable banking data to increase confidence in financial data. | + | Excel reports | Download reports in Excel format. | + | Manage data | Control how data is retrieved from an integration. | + | File upload | Endpoints to manage uploaded files. | + | Loan writeback | Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. | + + version: 3.0.0 + contact: + name: Codat + email: support@codat.io + termsOfService: 'https://www.codat.io/legals/' +security: + - auth_header: [] +x-speakeasy-retries: + strategy: backoff + backoff: + initialInterval: 500 + maxInterval: 60000 + maxElapsedTime: 3600000 + exponent: 1.5 + statusCodes: + - 408 + - 429 + - 5XX + retryConnectionErrors: true +x-speakeasy-name-override: + - operationId: ^list-.*? + methodNameOverride: list + - operationId: ^list-.*?-attachments + methodNameOverride: list-attachments + - operationId: ^get-.*? + methodNameOverride: get + - operationId: ^get-create-.*?-model + methodNameOverride: get-create-model + - operationId: ^get-create-update.*?-model + methodNameOverride: get-create-update-model + - operationId: ^get-.*?-attachment + methodNameOverride: get-attachment + - operationId: ^update-.*? + methodNameOverride: update + - operationId: ^create-.*? + methodNameOverride: create + - operationId: ^delete-.*? + methodNameOverride: delete + - operationId: ^delete-.*?-attachment + methodNameOverride: delete-attachment + - operationId: ^download-.*?-attachment + methodNameOverride: download-attachment + - operationId: ^upload-.*?-attachment + methodNameOverride: upload-attachment +x-codat-docs-path: lending-api +x-codat-keep-docs-paths-local: true +x-codat-speakeasy-pagination: + type: offsetLimit + inputs: + - name: page + in: parameters + type: page + outputs: + results: $.results +tags: + - name: Companies + description: Create and manage your SMB users' companies. + - name: Connections + description: Create new and manage existing data connections for a company. + - name: Bank statements + description: Retrieve banking data from linked bank accounts. + - name: Sales + description: Retrieve standardized sales data from a linked commerce software. + - name: Financial statements + description: Financial data and reports from a linked accounting software. + - name: Liabilities + description: Debt and other liabilities. + - name: Accounts payable + description: Data from a linked accounting software representing money the business owes money to its suppliers. + - name: Accounts receivable + description: Data from a linked accounting software representing money owed to the business for sold goods or services. + - name: Accounting bank data + description: Access bank transactions from an accounting software. + - name: Transactions + description: Data from a linked accounting software representing transactions. + - name: Company info + description: View company information fetched from the source platform. + - name: Data integrity + description: Match mutable accounting data with immutable banking data to increase confidence in financial data. + - name: Excel reports + description: Download reports in Excel format. + - name: Manage data + description: Control how data is retrieved from an integration. + - name: File upload + description: Endpoints to manage uploaded files. + - name: Loan writeback + description: 'Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle.' + - name: Manage reports + description: Generate and review generated reports for a company. + - name: Financial summary + description: 'View financial summary information for a company, including credit model reports and accounting score.' +paths: + /companies: + get: + summary: List companies + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Companies' + examples: + One company: + value: + results: + - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + name: My Test Company + description: My Test Company make testing software + platform: '' + redirect: 'https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6' + lastSync: '2022-01-01T12:30:00.000Z' + dataConnections: + - id: 51baa045-4836-4317-a42e-3542e991e581 + integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 + integrationKey: vjms + sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b + platformName: Pandle + linkUrl: 'https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-01-01T11:30:00Z' + createdByUserName: Mike Smith + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: [] + pageNumber: 1 + pageSize: 100 + totalResults: 1 + _links: + current: + href: /companies?page=1&pageSize=100 + self: + href: /companies + List of Companies: + value: + results: + - id: d1568dde-adf6-11ed-afa1-0242ac120002 + name: Technicalium + description: 'Technology services, including web and app design and development' + platform: '' + redirect: 'https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002' + lastSync: '2022-01-01T12:30:00.000Z' + dataConnections: + - id: 51baa045-4836-4317-a42e-3542e991e581 + integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 + integrationKey: vjms + sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b + platformName: Pandle + linkUrl: 'https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-01-01T11:30:00Z' + createdByUserName: Joe Bloggs + products: + - spend-insights + - lending + - payables-v2 + referenceSubsidiaryCompanies: [] + - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceSubsidiaryCompanies: + - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + links: + portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + links: + portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' + - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' + dataConnections: + - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - lending + - spend-insights + - payables + referenceParentCompany: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + redirect: 'https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913' + dataConnections: + - id: 1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/connections/1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceParentCompany: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + pageNumber: 1 + pageSize: 100 + totalResults: 3 + _links: + current: + href: /companies?page=1&pageSize=100 + self: + href: /companies + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-companies + description: "\uFEFFThe *List companies* endpoint returns a list of [companies](https://docs.codat.io/lending-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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.\n\n## Filter by tags\n\nThe *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):\n\n- equals (`=`)\n- not equals (`!=`)\n- contains (`~`)\n\nFor example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: \n- Foreign key: `uid = {yourCustomerId}`\n- Region: `region != uk`\n- Owning team and region: `region = uk && owningTeam = invoice-finance`" + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + - name: tags + in: query + schema: + type: string + example: region=uk && team=invoice-finance + description: 'Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying).' + post: + summary: Create company + tags: + - Companies + operationId: create-company + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/Company' + examples: + With no description: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceSubsidiaryCompanies: [] + With a description: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium + description: 'Technology services, including web and app design and development' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceSubsidiaryCompanies: [] + With a tag: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + tags: + region: us + referenceSubsidiaryCompanies: [] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/lending-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`." + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyRequestBody' + examples: + With no description: + value: + name: Technicalium + With a description: + value: + name: Technicalium + description: 'Technology services, including web and app design and development' + '/companies/{companyId}': + put: + summary: Replace company + description: "\uFEFFUse the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.\n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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." + operationId: replace-company + x-speakeasy-name-override: replace + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Company' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyRequestBody' + examples: + Update name: + value: + name: New Name + Update description: + value: + name: Same name + description: Additional documents required + patch: + summary: Update company + description: "\uFEFFUse the *Update company* endpoint to update the name, description, or tags of the company.\n\nThe *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update. \n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data." + operationId: update-company + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Company' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyUpdateRequest' + examples: + Update tags: + value: + tags: + refrence: new reference + Update name: + value: + name: New Name + delete: + summary: Delete a company + operationId: delete-company + parameters: + - $ref: '#/components/parameters/companyId' + description: "\uFEFFThe *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/lending-api#/schemas/Company), its [connections](https://docs.codat.io/lending-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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.\n" + tags: + - Companies + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + get: + summary: Get company + operationId: get-company + description: "\uFEFFThe *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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.\n" + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Company' + examples: + Simple company: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores holdings + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: [] + Parent multi-entity company: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: + - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + links: + portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + links: + portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' + Subsidiary multi-entity company: + value: + id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + description: '' + platform: '' + redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' + dataConnections: + - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceParentCompany: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections': + get: + summary: List connections + description: "\uFEFFList the connections for a company." + operationId: list-connections + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connections' + examples: + Connections: + value: + results: + - 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 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + _links: + self: + href: string + current: + href: string + next: + href: string + previous: + href: string + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + summary: Create connection + description: "\uFEFFCreates a connection for the company by providing a valid `platformKey`. \n\nUse the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. " + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Connections + operationId: create-connection + requestBody: + content: + application/json: + schema: + type: object + properties: + platformKey: + type: string + minLength: 4 + maxLength: 4 + pattern: '[a-z]{4}' + example: gbol + description: '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.' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: + Connection: + value: + 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 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}': + get: + summary: Get connection + operationId: get-connection + description: "\uFEFFReturns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned." + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: + Connection: + value: + 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 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + delete: + summary: Delete connection + operationId: delete-connection + description: "\uFEFFRevoke and remove a connection from a company.\nThis operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company." + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + tags: + - Connections + responses: + '200': + description: OK + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + patch: + summary: Unlink connection + description: "\uFEFFThis allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data." + operationId: unlink-connection + x-speakeasy-name-override: unlink + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + application/json: + schema: + title: Update connection + x-internal: true + type: object + properties: + status: + $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' + description: The current authorization status of the data connection. + nullable: true + additionalProperties: false + examples: + Example: + value: + status: Unlinked + description: '' + '/companies/{companyId}/data/all': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Refresh all data + operationId: refresh-all-data-types + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: all-data-types + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Refreshes all data types with `fetch on first link` set to `true` for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + + [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. + tags: + - Manage data + '/companies/{companyId}/dataStatus': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get data status + operationId: get-data-status + x-speakeasy-group: manage-data + x-speakeasy-name-override: get-status + description: Get the state of each data type for a company + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + title: Data statuses + x-internal: true + type: object + properties: + accountTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + balanceSheet: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + billCreditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + billPayments: + $ref: '#/components/schemas/DataStatus' + nullable: true + bills: + $ref: '#/components/schemas/DataStatus' + nullable: true + cashFlowStatement: + $ref: '#/components/schemas/DataStatus' + nullable: true + chartOfAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + company: + $ref: '#/components/schemas/DataStatus' + nullable: true + creditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + directCosts: + $ref: '#/components/schemas/DataStatus' + nullable: true + directIncomes: + $ref: '#/components/schemas/DataStatus' + nullable: true + invoices: + $ref: '#/components/schemas/DataStatus' + nullable: true + itemReceipts: + $ref: '#/components/schemas/DataStatus' + nullable: true + items: + $ref: '#/components/schemas/DataStatus' + nullable: true + journalEntries: + $ref: '#/components/schemas/DataStatus' + nullable: true + journals: + $ref: '#/components/schemas/DataStatus' + nullable: true + paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + profitAndLoss: + $ref: '#/components/schemas/DataStatus' + nullable: true + purchaseOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + salesOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + suppliers: + $ref: '#/components/schemas/DataStatus' + nullable: true + taxRates: + $ref: '#/components/schemas/DataStatus' + nullable: true + trackingCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + transfers: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accountBalances: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactionCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-companyInfo: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-disputes: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-locations: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-orders: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-productCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-products: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-taxComponents: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + examples: + Example: + value: + accountTransactions: + dataType: accountTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + balanceSheet: + dataType: balanceSheet + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankAccounts: + dataType: bankAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankTransactions: + dataType: bankTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billCreditNotes: + dataType: billCreditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billPayments: + dataType: billPayments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bills: + dataType: bills + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + cashFlowStatement: + dataType: cashFlowStatement + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + chartOfAccounts: + dataType: chartOfAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + company: + dataType: company + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + creditNotes: + dataType: creditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + customers: + dataType: customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directCosts: + dataType: directCosts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directIncomes: + dataType: directIncomes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + invoices: + dataType: invoices + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + itemReceipts: + dataType: itemReceipts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + items: + dataType: items + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journalEntries: + dataType: journalEntries + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journals: + dataType: journals + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + paymentMethods: + dataType: paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + payments: + dataType: payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + profitAndLoss: + dataType: profitAndLoss + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + purchaseOrders: + dataType: purchaseOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + salesOrders: + dataType: salesOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + suppliers: + dataType: suppliers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + taxRates: + dataType: taxRates + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + trackingCategories: + dataType: trackingCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + transfers: + dataType: transfers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accountBalances: + dataType: banking-accountBalances + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accounts: + dataType: banking-accounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactionCategories: + dataType: banking-transactionCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactions: + dataType: banking-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-companyInfo: + dataType: commerce-companyInfo + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-customers: + dataType: commerce-customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-disputes: + dataType: commerce-disputes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-locations: + dataType: commerce-locations + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-orders: + dataType: commerce-orders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-paymentMethods: + dataType: commerce-paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-payments: + dataType: commerce-payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-productCategories: + dataType: commerce-productCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-products: + dataType: commerce-products + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-taxComponents: + dataType: commerce-taxComponents + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-transactions: + dataType: commerce-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/queue/{dataType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataType' + post: + summary: Refresh data type + operationId: refresh-data-type + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: data-type + description: |- + Refreshes a given data type for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + tags: + - Manage data + parameters: + - schema: + type: string + format: uuid + in: query + name: connectionId + description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/history': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List pull operations + tags: + - Manage data + operationId: list-pull-operations + x-speakeasy-group: manage-data.pull-operations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperations' + examples: + Example: + value: + results: + - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b + companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 + connectionId: 51baa045-4836-4317-a42e-3542e991e581 + dataType: invoices + status: Initial + requested: '2022-11-14T11:18:37.2798351Z' + progress: 10 + isCompleted: false + isErrored: false + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets the pull operation history (datasets) for a given company. + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/data/history/{datasetId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/datasetId' + get: + summary: Get pull operation + operationId: get-pull-operation + x-speakeasy-group: manage-data.pull-operations + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Retrieve information about a single dataset or pull operation. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity status + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityStatuses' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-status + x-speakeasy-name-override: status + description: |- + The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching. + This endpoint helps you understand whether match data is available and, if so, how to usefully query it. + + The response tells you: + + - Whether match results are available. + - When the results were generated, and their status. + - The connection IDs, amounts, and dates involved to support useful querying. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity summaries + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegritySummaries' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-summaries + x-speakeasy-name-override: summaries + description: |- + The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). + + For example, if you wanted to see summary match results only for transactions after 1 December 2020, you could include a query parameter of `query=date>2020-12-01`. + + The endpoint response includes only the summary results, not transactions. To view match data for transactions, use the [List data integrity details](https://docs.codat.io/lending-api#/operations/get-data-integrity-summaries) endpoint. + parameters: + - $ref: '#/components/parameters/query' + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: List data integrity details + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityDetails' + examples: {} + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-data-integrity-details + x-speakeasy-name-override: details + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results. + + The [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetail) are paginated and support ordering, following the same conventions as our other data endpoints. + '/companies/{companyId}/reports/enhancedProfitAndLoss/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized profit and loss statement + description: |- + The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedProfitAndLossAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:40:59.0847354Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 830.93 + accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + accountName: Repairs & Maintenance + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 12000 + accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + accountName: Wages + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 28937.71 + accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + accountName: Purchases + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 582.4 + accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + accountName: Purchase Discounts + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 350.44 + accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + accountName: Charitable and Political Donations + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Donations + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 535.81 + accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + accountName: Interest Paid (operating) + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Interest + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 633.05 + accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + accountName: Corporation Tax + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Taxes + confidence: 99.99 + - levelName: CorporationTaxes + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 782.61 + accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + accountName: Bank Fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: BankCharges + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 8000 + accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + accountName: Rent + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: BuildingRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1090.68 + accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + accountName: Motor Vehicle Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: EquipmentRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 26307.02 + accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + accountName: Advertising & Marketing + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1128.85 + accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + accountName: 'Postage, Freight & Courier' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 40 + accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + accountName: Subscriptions + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 5.72 + accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + accountName: Amortization + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Amortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1539.18 + accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + accountName: Depreciation Expense + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Depreciation + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1416.05 + accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + accountName: Entertainment-100% business + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: EmployeeBenefits + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1465.61 + accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + accountName: General Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 7347.35 + accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + accountName: 'Light, Power, Heating' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1027.25 + accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + accountName: Printing & Stationery + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 45 + accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + accountName: Telephone & Internet + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + accountName: Audit & Accountancy fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 130 + accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + accountName: Cleaning + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 860.02 + accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + accountName: Travel - National + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Travel + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 850.22 + accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + accountName: Other Revenue + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Online + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 138457.98 + accountId: 72df89d2-512b-4455-af51-a6b563733842 + accountName: Sales + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Wholesale + confidence: 99.99 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-categorized-profit-and-loss-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/reportDate' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedBalanceSheet/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized balance sheet statement + operationId: get-categorized-balance-sheet-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.balance-sheet + description: |- + The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedBalanceSheetAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:42:09.2973105Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 12973.03 + accountId: 22de1660-d745-4809-a363-16b134607e66 + accountName: Prepayments + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedDeferredAssets + confidence: 99.99 + - levelName: PrepaidExpenses + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 316065.92 + accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + accountName: Business Current Account + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 65945.07 + accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + accountName: Inventory + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 71937.95 + accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + accountName: Accounts Receivable + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Receivables + confidence: 99.99 + - levelName: AccountsReceivables + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2180148.56 + accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + accountName: Office Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1804674.9 + accountId: be3eb911-034b-42de-95db-0d58ac978b7f + accountName: Computer Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 3417424.16 + accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + accountName: Retained Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: RetainedEarnings + confidence: 99.99 + - levelName: CapitalIncomeReserve + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 44252.52 + accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + accountName: Current Year Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: ShareCapital + confidence: 99.99 + - levelName: CommonStock + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 75835.64 + accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + accountName: Accounts Payable + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccountsPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 208264.65 + accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + accountName: Accruals + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedLiabilities + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + accountName: Rounding + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 25184.57 + accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + accountName: Credit Card Control Account + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: CreditCards + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 9650.58 + accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + accountName: Historical Adjustment + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2022.41 + accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + accountName: John Smith + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 29034.75 + accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + accountName: VAT + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1076.55 + accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + accountName: Interest Payables + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + accountName: Unpaid Expense Claims + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 638999.6 + accountId: 55008233-40e7-41ac-84af-2255fa028c2e + accountName: Loan + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedCashFlow/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized bank statement + operationId: get-categorized-bank-statement + x-speakeasy-group: banking.categorized-statement + description: "\uFEFF> **Categorization engine**\n>\n> The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.\n\nThe _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources." + tags: + - Bank statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCashFlowTransactions' + examples: + Categorized bank statement: + $ref: '#/components/examples/EnhancedCashflowExample' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + '/companies/{companyId}/reports/enhancedInvoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List reconciled invoices + tags: + - Accounts receivable + operationId: list-reconciled-invoices + x-speakeasy-name-override: list-reconciled + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/EnhancedInvoicesReport' + example: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 101 + reportName: Invoices report + companyName: Small Sandbox + generatedDate: '2023-05-10T10:50:23.9437977Z' + reportItems: + - id: 15221fa4-e91a-4f64-a2bb-caeab4db85a4 + invoiceNumber: UDs5KlfE + customerRef: + id: ee4d0eee-063d-4c9f-8226-2c9a6a816249 + customerName: Serena Keeling + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 7044.83 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-02-27T18:28:00' + payments: [] + - id: 58aea1cb-5b31-4eed-ba16-489dfa67a831 + invoiceNumber: 1IU1PMoT + customerRef: + id: 81e9c0df-3e5e-4180-b20c-c8e58100cdf3 + customerName: Quinton Kovacek + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 3567.59 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-06-23T22:47:00' + payments: [] + - id: 9ecd07bc-9cab-4516-bad0-a0cd565cdbaf + invoiceNumber: eEIWyPN4 + customerRef: + id: c7326084-cd56-48e6-bcfa-be8919e024e1 + customerName: Antwon Dach + issueDate: '2021-04-08T01:27:00' + dueDate: '2021-04-18T01:27:00' + status: Paid + currency: GBP + totalAmount: 153233.36 + amountDue: 0 + paidOnDate: '2021-04-10T12:31:00' + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2021-11-11T12:10:00' + payments: + - id: 0878e8be-6746-4347-80ba-5491328c8411 + date: '2021-04-10T12:31:00' + paymentType: payments + amount: 153233.36 + currency: GBP + currencyRate: 1 + - id: 7cea078a-5c9a-4788-ae72-9bb60c5cc184 + invoiceNumber: BXb8mYQW + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-04-16T17:30:00' + dueDate: '2021-04-23T17:30:00' + status: Paid + currency: GBP + totalAmount: 12657.69 + amountDue: 0 + paidOnDate: '2021-04-23T17:30:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-12-08T11:32:00' + payments: + - id: 17b42934-13f6-4738-a506-2e253b1a606f + date: '2021-04-23T17:30:00' + paymentType: payments + amount: 12657.69 + currency: GBP + currencyRate: 1 + - id: aa4503d7-fe01-49fe-ba42-259b421ac640 + invoiceNumber: wdjwiL5B + customerRef: + id: 5cbaf1af-4f02-4206-85ab-c525bd9b4f99 + customerName: Bryana Douglas + issueDate: '2021-04-20T06:46:00' + dueDate: '2021-04-27T06:46:00' + status: PartiallyPaid + currency: GBP + totalAmount: 12935.39 + amountDue: 381.09 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-03-11T20:03:00' + payments: + - id: 1c03986b-9b6c-4220-bde6-4e3eba6cef9f + date: '2021-04-23T14:59:00' + paymentType: payments + amount: 12554.3 + currency: GBP + currencyRate: 1 + - id: d8a0e26e-4ec8-4fb5-887d-8b7531e3bedf + invoiceNumber: cTjJcu8x + customerRef: + id: 6f5290e5-70aa-4d0c-816e-9d2312cf217f + customerName: Brady Wilderman + issueDate: '2021-04-23T09:32:00' + dueDate: '2021-05-03T09:32:00' + status: Paid + currency: GBP + totalAmount: 21526.72 + amountDue: 0 + paidOnDate: '2021-05-03T09:32:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-12T22:37:00' + payments: + - id: 93c9c11b-3ec0-4314-85f6-0751763e752a + date: '2021-05-03T09:32:00' + paymentType: payments + amount: 21506.72 + currency: GBP + currencyRate: 1 + - id: 06890e67-35fb-4276-9857-95db40cfd15d + invoiceNumber: htXJuUDb + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-01T23:23:00' + dueDate: '2021-05-11T23:23:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7151.41 + amountDue: 1225.06 + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2022-02-24T23:02:00' + payments: + - id: 82865077-0857-46db-b9a1-6d21da43b6aa + date: '2021-05-04T17:57:00' + paymentType: payments + amount: 5926.35 + currency: GBP + currencyRate: 1 + - id: 160e8b51-1fa0-46b9-98fe-1ff5399ce99b + invoiceNumber: 9wegEXpG + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-18T08:53:00' + dueDate: '2021-05-25T08:53:00' + status: PartiallyPaid + currency: GBP + totalAmount: 22522.34 + amountDue: 14408.54 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-01-13T07:52:00' + payments: + - id: 75bd7205-bc12-4517-9964-aae159fdfaee + date: '2021-05-23T04:04:00' + paymentType: payments + amount: 8113.8 + currency: GBP + currencyRate: 1 + - id: 5a934955-561d-436a-a564-fd624a79f54c + invoiceNumber: l7YwGxG7 + customerRef: + id: cc96af36-e2f5-49f7-bf40-271503f45071 + customerName: Ignacio Moore + issueDate: '2021-05-25T19:51:00' + dueDate: '2021-06-04T19:51:00' + status: Paid + currency: GBP + totalAmount: 11047.08 + amountDue: 0 + paidOnDate: '2021-05-28T07:31:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-08-06T05:50:00' + payments: + - id: 608fd022-f7d0-44a9-90c4-bebe0573f206 + date: '2021-05-28T07:31:00' + paymentType: payments + amount: 11047.08 + currency: GBP + currencyRate: 1 + - id: 17690788-2936-46b5-ba46-ba6a36a87483 + invoiceNumber: ntH1cRYz + customerRef: + id: e1ecc8f2-8a63-4fe9-97c9-c87fd90ca0a6 + customerName: Freida Ebert + issueDate: '2021-05-27T19:07:00' + dueDate: '2021-06-03T19:07:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7191.32 + amountDue: 5036.83 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-27T08:54:00' + payments: + - id: a343b2a0-d327-41b0-993e-7b6b92fde425 + date: '2021-06-03T19:07:00' + paymentType: payments + amount: 2154.49 + currency: GBP + currencyRate: 1 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets a list of invoices linked to the corresponding banking transaction + '/companies/{companyId}/reports/liabilities/loans/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan transactions report + description: | + The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-transactions + x-speakeasy-name-override: generate-loan-transactions + get: + summary: List loan transactions + description: | + The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. + + This detail gives analysts a better idea of the loan obligations a company may have. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanTransactions' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-loan-transactions + x-speakeasy-name-override: list-loan-transactions + '/companies/{companyId}/reports/liabilities/loans': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan summaries report + description: | + The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-summary + x-speakeasy-name-override: generate-loan-summary + get: + summary: Get loan summaries + description: | + The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. + + The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanSummary' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-loan-summary + x-speakeasy-name-override: get-loan-summary + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get commerce revenue metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: revenue + displayName: Revenue + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Revenue metrics + type: string + items: + - index: 0 + value: Revenue + - index: 1 + value: Revenue growth + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + - displayName: Percentage change vs. previous period + units: '%' + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 0 + itemDisplayName: Revenue + measures: + - index: 0 + measureDisplayName: Value + value: 2392.48 + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 1 + itemDisplayName: Revenue growth + measures: + - index: 1 + measureDisplayName: Percentage change vs. previous period + value: 276.65 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-revenue-metrics + x-speakeasy-name-override: get-revenue + x-speakeasy-group: sales.metrics + description: | + The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the revenue metrics. + + #### Response structure + + The Revenue report's dimensions and measures are: + + | Index | Dimensions | + |---------------|------------| + | `index` = 0 | Period | + | `index` = 1 | Revenue | + + | Index | Measures | + |---------------|--------------------------------------------------------------------------------------------------------------------------| + | `index` = 0 | Value | + | `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get orders report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: orders + displayName: Orders + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Order metrics + type: string + items: + - index: 0 + value: Number of orders + - index: 1 + value: Total value + - index: 2 + value: Average order value + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Order metrics + item: 0 + itemDisplayName: Number of orders + measures: + - index: 0 + measureDisplayName: Count + value: 94 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 1 + itemDisplayName: Total value + measures: + - index: 1 + measureDisplayName: Value + value: 3315.18 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 2 + itemDisplayName: Average order value + measures: + - index: 1 + measureDisplayName: Value + value: 35.27 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-orders-report + x-speakeasy-name-override: get-orders + x-speakeasy-group: sales.reports + description: | + The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the order metrics. + + #### Response structure + + The Orders report's dimensions and measures are: + + | Index | Dimensions | + |---------------|----------------| + | `index` = 0 | Period | + | `index` = 1 | Order metrics | + + | Index | Measures | + |---------------|------------| + | `index` = 0 | Count | + | `index` = 1 | Value | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get refunds report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: refunds + displayName: Refunds + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Refund metrics + type: string + items: + - index: 0 + value: Number of refunds + - index: 1 + value: Value of refunds + - index: 2 + value: Refund rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + - displayName: Percentage + units: '%' + index: 2 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 0 + itemDisplayName: Number of refunds + measures: + - index: 0 + measureDisplayName: Count + value: 39 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 1 + itemDisplayName: Value of refunds + measures: + - index: 1 + measureDisplayName: Value + value: 642.82 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 2 + itemDisplayName: Refund rate + measures: + - index: 2 + measureDisplayName: Percentage + value: 0.41 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-refunds-report + x-speakeasy-name-override: get-refunds + x-speakeasy-group: sales.reports + description: | + The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the refunds metrics. + + #### Response structure + + The Refunds report's dimensions and measures are: + + | Index | Dimensions | + |----------------|----------------| + | `index` = 0 | Period | + | `index` = 1 | Refund metrics | + + | Index | Measures | + |----------------|------------| + | `index` = 0 | Count | + | `index` = 1 | Value | + | `index` = 2 | Percentage | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get customer retention metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: customer_retention + displayName: Customer Retention + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Customer retention metrics + type: string + items: + - index: 0 + value: Existing customers + - index: 1 + value: New customers + - index: 2 + value: Total customers + - index: 3 + value: Retention rate + - index: 4 + value: Repeat rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Percentage + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 0 + itemDisplayName: Existing customers + measures: + - index: 0 + measureDisplayName: Count + value: 13 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 1 + itemDisplayName: New customers + measures: + - index: 0 + measureDisplayName: Count + value: 47 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 2 + itemDisplayName: Total customers + measures: + - index: 0 + measureDisplayName: Count + value: 60 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 3 + itemDisplayName: Retention rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 0 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 4 + itemDisplayName: Repeat rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 21.67 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-customer-retention-metrics + x-speakeasy-name-override: get-customer-retention + x-speakeasy-group: sales.metrics + description: |- + The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + #### Customer retention metrics + + - __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period. + - __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period. + - __Total customers__: the total number of existing and new customers within the specified period. + - __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage. + - __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate customer retention metrics. + + #### Response structure + + The Customer retention report's dimensions and measures are: + + | Index | Dimensions | + |-----------------------------|----------------------------| + | `index` = 0 | Period | + | `index` = 1 | Customer retention metrics | + + | Index | Measures | + |----------------------|------------| + | `index` = 0 | Count | + | `index` = 1 | Percentage | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get lifetime value metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: lifetime_value + displayName: Lifetime Value + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Lifetime value metrics + type: string + items: + - index: 0 + value: Lifetime value + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Lifetime value metrics + item: 0 + itemDisplayName: Lifetime value + measures: + - index: 0 + measureDisplayName: Value + value: 3782.07 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-lifetime-value-metrics + x-speakeasy-name-override: get-lifetime-value + x-speakeasy-group: sales.metrics + description: | + The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the lifetime value metrics. + + #### Response structure + + The Lifetime value report's dimensions and measures are: + + | Index | Dimensions | + |---------------|------------------------| + | `index` = 0 | Period | + | `index` = 1 | Lifetime value metrics | + + | Index | Measures | + |-------------------|---------| + | `index` = 1 | Value | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/assess/excel': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Generate Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-excel-report + x-speakeasy-name-override: generate + description: |+ + The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter. + + In response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request. + + ### Report types + + | reportType | Description | + |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| + | `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || [audit](https://docs.codat.io/lending/excel/audit-report) | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. | + | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. | + | `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. | + | `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. | + + [Learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types. + + + parameters: + - $ref: '#/components/parameters/excelReportType' + get: + summary: Get Excel report status + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-excel-report-generation-status + x-speakeasy-name-override: get-status + description: "\uFEFFThe *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests. \n\nPoll this endpoint to check the progress of the report once you have requested its generation. This will not affect the generation of the report. \n\nWhen the report generation completes successfully, the `inProgress` property will be marked as `false` and the `success` field will be marked as `true`." + parameters: + - $ref: '#/components/parameters/excelReportType' + '/data/companies/{companyId}/assess/excel/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Download Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: download-excel-report + x-speakeasy-name-override: download + description: "\uFEFFThe *Download Excel report* endpoint downloads the latest successfully generated Excel report of a specified report type for a given company. \n\nThe downloadable Excel file is returned in the response. You can save it to your local machine.\n\nYou can [learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types." + parameters: + - $ref: '#/components/parameters/excelReportType' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions': + get: + tags: + - Transactions + summary: List account transactions + description: |- + The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection. + + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-account-transactions + x-speakeasy-group: transactions.account-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransactions' + examples: + Clear Books: + value: + results: + - id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: f2656119-9521-4d51-a24d-003b44c1410b + transactionId: 1fde4f8f-68ca-48fc-8fe7-79ac467d2946 + note: Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Void + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + amount: 32095.91 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1745 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + transactionId: DFA-933785132 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-05T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: DFA-933785132 + dataType: directCosts + amount: -35 + totalAmount: -35 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 652 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: '5' + transactionId: '5' + bankAccountRef: + id: '81' + name: Current + date: '2015-11-24T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: contribution to start business + recordRef: + id: 5-1 + dataType: directIncomes + amount: 10000 + - description: funds borrowed to start business + recordRef: + id: 5-2 + dataType: directIncomes + amount: 25000 + totalAmount: 35000 + modifiedDate: '2023-04-26T09:37:17' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + transactionId: '15' + note: Payment to Google + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Payment to Google + recordRef: + id: PUR-15 + dataType: directCosts + amount: -1.59 + totalAmount: -1.59 + modifiedDate: '2023-01-18T11:03:11' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5984 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2 + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + transactionId: 65b746c8-9a5d-4a95-8096-d2316fcff592 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2022-02-17T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + dataType: payments + amount: 4200 + totalAmount: 4200 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}': + get: + tags: + - Transactions + summary: Get account transaction + operationId: get-accounting-account-transaction + x-speakeasy-group: transactions.account-transactions + description: | + The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. + + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: accountTransactionId + in: path + required: true + schema: + type: string + description: Unique identifier for an account transaction. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransaction' + examples: + Clear Books: + value: + id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts': + get: + tags: + - Financial statements + summary: List accounts + description: "\uFEFFThe *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data)." + operationId: list-accounting-accounts + x-speakeasy-group: financial-statements.accounts + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/AccountingAccounts' + examples: + Clear Books: + value: + results: + - id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 76d5f23b-9623-4e3b-89cd-da57228764d3 + nominalCode: '611' + name: Accounts Receivable + description: A provision anticipating that a portion of accounts receivable will never be collected. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-10-19T05:49:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 98 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: c0861a65-c69f-ec11-80f1-0022481b4546 + nominalCode: '10' + name: Account no cat Balance Sheet + fullyQualifiedCategory: ' .' + fullyQualifiedName: ..Account no cat Balance Sheet + currency: GBP + currentBalance: 27.34 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-09-13T14:45:01Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 122 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: 2052b65b-20e9-4da1-85d8-fd5ca0ea3d38 + nominalCode: '888777888' + name: One more AR account + description: One more AR account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled + currency: EUR + currentBalance: 2174.82 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2021-06-10T11:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 230 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: cf9572e7-8afa-4339-9113-af32a66d9df9 + nominalCode: '15400' + name: Trade Debtors + description: Trade Debtors + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled + currency: GBP + currentBalance: 4484655.39 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2020-01-08T13:48:38Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 121 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '605' + nominalCode: '605' + name: Capital Asset Depreciation Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Depreciation Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 292 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '128611' + nominalCode: 1200-1 + name: Accounts Receivable + fullyQualifiedCategory: Asset.Accounts Receivable + fullyQualifiedName: Asset.Accounts Receivable.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 96 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + - id: '27840049' + nominalCode: '70600' + name: 1a1a + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.1a1a + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 157 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + - id: '119' + name: Accounts Receivable + fullyQualifiedCategory: AcctRec.AcctRec + fullyQualifiedName: AcctRec.AcctRec.Accounts Receivable + currentBalance: -565 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-09-08T15:23:31' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 20000-933270541 + nominalCode: '10100' + name: Checking + description: Cash + fullyQualifiedCategory: Asset.CurrentAsset.Bank + fullyQualifiedName: Asset.CurrentAsset.Bank.Checking + currency: GBP + currentBalance: 46954.1 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: + - property: Id + links: + - BillLineItem.AccountRef.Id + - BillPayment.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 116 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + - id: '92' + nominalCode: '247' + name: Debtors - AED + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - AED + currency: AED + currentBalance: -1533.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2021-02-19T14:04:45Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 234 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '80' + name: Debtors - USD + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - USD + currency: USD + currentBalance: 54822.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-12T15:10:38Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 186 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + metadata: + isDeleted: true + - id: '2368' + nominalCode: '1200' + name: Bank Current Account + description: Bank Current Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Current Account + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-09-11T13:53:12Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 344 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '1102' + nominalCode: '1102' + name: Other Debtors + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Other Debtors + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 155 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: b17083bc9b2748b4ab321b024e260eda + nominalCode: '147852' + name: Abdi Live Test + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Live Test + currency: GBP + currentBalance: 225830.75 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 283 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '155' + nominalCode: '12710' + name: AR - Retainage + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.AR - Retainage' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-10-15T15:33:15' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 181 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=2&pageSize=2 + Wave: + value: + results: + - id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + - id: QWNjb3VudDo3OTE3NTA1OTcwOTQxNzQ3MTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Cash on Hand + description: Cash you haven�t deposited in the bank. Add your bank and credit card accounts to accurately categorize transactions that aren't cash. + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Cash on Hand + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 85 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + nominalCode: A091 + name: Business Savings Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Savings Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + - id: '104957000000060010' + nominalCode: '' + name: Abdi Test + description: '' + fullyQualifiedCategory: Asset.bank + fullyQualifiedName: Asset.bank.Abdi Test + currency: GBP + currentBalance: 69858.44 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-17T12:19:47' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 68 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Financial statements + summary: Get account + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount' + examples: + Clear Books: + value: + id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + Dynamics 365 Business Central: + value: + id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + Exact (Netherlands): + value: + id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Exact (UK): + value: + id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + FreeAgent: + value: + id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + FreshBooks: + value: + id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + KashFlow: + value: + id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + Oracle NetSuite: + value: + id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + QuickBooks Desktop: + value: + id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + QuickBooks Online: + value: + id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + QuickBooks Online Sandbox: + value: + id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + Sage 200cloud: + value: + id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + Sage 50 (UK): + value: + id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + Sage Business Cloud Accounting: + value: + id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Sage Intacct: + value: + id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + Wave: + value: + id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + Zoho Books: + value: + id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-account + x-speakeasy-group: financial-statements.accounts + '/companies/{companyId}/data/billCreditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + - id: 157c025f-a19e-eb11-8ce6-0022481a7bed + billCreditNoteNumber: '109002' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 20 + totalDiscount: 0 + subTotal: 20 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 257c025f-a19e-eb11-8ce6-0022481a7bed + note: Credit Memo 1002 + reference: '109002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-04-16T00:00:00' + totalAmount: 10 + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: '16042021' + pageNumber: 1 + pageSize: 2 + totalResults: 224 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + - id: 6643f559-d7e9-4cfe-802f-60beddbc4ed9 + billCreditNoteNumber: '20600003' + supplierRef: + id: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + withholdingTax: [] + totalAmount: 13.57 + totalDiscount: 0 + subTotal: 13.57 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 13.57 + status: Submitted + issueDate: '2020-01-20T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + unitAmount: 13.57 + quantity: 1 + discountAmount: 0 + subTotal: 13.57 + totalAmount: 13.57 + accountRef: + id: f6c251f5-21d0-4164-9b8f-17789fd2fee9 + name: Kosten werkgeverslasten vakantiegeld + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-20T19:38:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + - id: 05023688-5bd5-4034-ae4c-5e3e5099bbfb + billCreditNoteNumber: '19600009' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2019-11-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Credit note line item #5' + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + totalAmount: 10 + accountRef: + id: 62be6536-f4ea-49b8-9797-1adc23982334 + name: Depreciation + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-11-01T15:07:18Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + - id: '11007024' + billCreditNoteNumber: Draft test + supplierRef: + id: '6161963' + supplierName: ABB Ltd + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 8.33 + totalTaxAmount: 1.67 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2018-10-17T00:00:00' + currency: GBP + lineItems: + - description: ABB Ltd - Bill Credit Note Draft test + unitAmount: 8.33 + quantity: 1 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-10-17T12:56:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + - id: '91341939' + billCreditNoteNumber: '6' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 240 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: -200 + quantity: -1 + subTotal: 200 + taxAmount: -40 + totalAmount: 240 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '114821376' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + - id: '1782' + billCreditNoteNumber: VENDCRED2 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 642.3 + totalDiscount: 0 + subTotal: 535.25 + totalTaxAmount: 107.05 + discountPercentage: 0 + remainingCredit: 342.3 + status: PartiallyPaid + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Cheese + unitAmount: 400 + quantity: 1 + unitOfMeasurement: pack + subTotal: 400 + totalAmount: 400 + accountRef: + id: '714' + name: Cost of Goods Sold + createdFromLineRef: + id: '7462' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: double cream + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '714' + name: Cost of Goods Sold + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: '' + unitAmount: 35.25 + quantity: 1 + subTotal: 35.25 + totalAmount: 35.25 + accountRef: + id: '54' + name: Sales + itemRef: + id: '128' + name: Test Item + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: '1782' + note: Codat1 + reference: Bill Credit 02/11/2021 + currency: GBP + currencyRate: 1 + paidOnDate: '2021-11-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + createdFromRefs: + - id: '7462' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-03T18:27:14' + note: Codat1 + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + - id: F3A-933787869 + billCreditNoteNumber: CR-1098 + supplierRef: + id: 80000-933272656 + supplierName: Sloan Roofing + withholdingTax: [] + totalAmount: 850 + totalDiscount: 0 + subTotal: 850 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 850 + status: Submitted + issueDate: '2024-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Subs:Roofing - Roofing' + unitAmount: 850 + quantity: 0 + discountAmount: 0 + subTotal: 850 + taxAmount: 0 + totalAmount: 850 + discountPercentage: 0 + itemRef: + id: D0000-933272656 + name: 'Subs:Roofing' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: F3A-933787869 + reference: CR-1098 + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 850 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:05:03' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + - id: '677' + billCreditNoteNumber: '677' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-03-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + note: Codat Note field + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + - id: '455' + billCreditNoteNumber: '455' + supplierRef: + id: '53' + supplierName: Bank of AnyCity + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-06-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: a + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '11' + name: Ask My Accountant + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '530' + reference: '4' + accountRef: + id: '100' + name: Savings2 + currency: GBP + currencyRate: 1 + paidOnDate: '2019-07-16T00:00:00' + totalAmount: 170 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-07-16T09:49:14Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + - id: '45421' + billCreditNoteNumber: Return 2 + supplierRef: + id: QUA001 + supplierName: Quality Motors + withholdingTax: [] + totalAmount: 60 + totalDiscount: 1.25 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 2.5 + remainingCredit: 60 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-02-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.25 + subTotal: 0 + taxAmount: 10 + totalAmount: 10 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.25 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + - id: '323' + billCreditNoteNumber: Return + supplierRef: + id: UNI001 + supplierName: Unique Systems + withholdingTax: [] + totalAmount: 103.4 + totalDiscount: 0 + subTotal: 88 + totalTaxAmount: 15.4 + discountPercentage: 0 + remainingCredit: 103.4 + status: Submitted + issueDate: '2022-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Returned Goods, damaged' + unitAmount: 103.4 + quantity: 1 + subTotal: 88 + taxAmount: 15.4 + totalAmount: 103.4 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: 'Returned Goods, damaged' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + - id: 23d866f6367d4f11956a36a71e47bc37 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + withholdingTax: [] + totalAmount: 60 + totalDiscount: 0 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 0 + remainingCredit: 60 + status: Submitted + issueDate: '2019-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 5 + discountAmount: 0 + subTotal: 50 + taxAmount: 10 + totalAmount: 60 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2020-07-16T15:00:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 747 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + - id: '3399' + billCreditNoteNumber: APADJ0002 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 360 + totalDiscount: 0 + subTotal: 300 + totalTaxAmount: 60 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-09-24T00:00:00' + allocatedOnDate: '2021-09-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 300 + quantity: 1 + subTotal: 300 + taxAmount: 60 + totalAmount: 360 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '81' + name: UK Purchase Goods Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-29T13:34:47' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=2&pageSize=2 + Xero: + value: + results: + - id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + - id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + billCreditNoteNumber: 720-2 + supplierRef: + id: cf8fa320-a527-496c-823e-22dd069d29e6 + supplierName: PC Complete + withholdingTax: [] + totalAmount: 270.36 + totalDiscount: 0 + subTotal: 270.36 + totalTaxAmount: 45.06 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-16T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Unable to supply DVD writer for laptop + unitAmount: 225.3 + quantity: 1 + discountAmount: 0 + subTotal: 225.3 + taxAmount: 45.06 + totalAmount: 270.36 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-16T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-16T00:00:00' + totalAmount: 270.36 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-06T21:00:33' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection. + + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-bill-credit-notes + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: billCreditNoteId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill credit note. + get: + tags: + - Accounts payable + summary: Get bill credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + Exact (Netherlands): + value: + id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + Exact (UK): + value: + id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + FreeAgent: + value: + id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + createdFromLineRef: + id: '1432' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + createdFromRefs: + - id: '1432' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + QuickBooks Desktop: + value: + id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + QuickBooks Online Sandbox: + value: + id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + Sage 50 (UK): + value: + id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + Sage Business Cloud Accounting: + value: + id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + Sage Intacct: + value: + id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + Xero: + value: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. + + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-credit-note + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billPayments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayments' + examples: + Clear Books: + value: + results: + - id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + - id: ca0976d0-036d-4187-ab66-7169286b007d + supplierRef: + id: 9efd64dc-4b31-425d-9eb2-7c7773593713 + supplierName: 'Jacobson, Konopelski and Heidenreich' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 16221.64 + currency: GBP + currencyRate: 1 + date: '2022-05-14T13:12:00' + note: Bill Payment against bill 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + paymentMethodRef: + id: fc87fba8-812e-4a54-b633-29ef2abf4c12 + name: CreditCard payments-u4p + lines: + - amount: 16221.64 + links: + - type: Bill + id: 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + amount: -16221.64 + currencyRate: 1 + allocatedOnDate: '2022-05-14T13:12:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-14T13:12:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 232 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + - id: 3d387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 390 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107007 + lines: + - amount: 390 + links: + - type: Bill + id: cbcb06bf-89d1-ea11-bbaa-000d3a2b9185-108007 + amount: -390 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108007' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 236 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + - id: 002b8462-f3a3-4019-84fe-6a2af1f30c5a + supplierRef: + id: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + accountRef: + id: 1879b322-7758-4e20-8f3f-701df27f2340 + name: Kas + totalAmount: 0.13 + currency: EUR + currencyRate: 1 + date: '2019-11-07T00:00:00Z' + lines: + - amount: -0.12 + links: + - type: CreditNote + id: 33f3016c-2ecf-4d17-911e-b385537e7341 + amount: 0.12 + currencyRate: 1 + - amount: 0.12 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.12 + currencyRate: 1 + - amount: 0.13 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.13 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2021-11-17T12:08:10Z' + reference: '19100002' + pageNumber: 1 + pageSize: 2 + totalResults: 1173 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + - id: b358df76-3930-42ad-8f38-78edcc60172d + supplierRef: + id: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 55000 + currency: GBP + currencyRate: 1 + date: '2017-10-31T00:00:00Z' + lines: + - amount: 55000 + links: + - type: PaymentOnAccount + id: 41302634-76b5-4442-b800-0bb63780e77c + amount: -55000 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2019-02-14T17:56:54Z' + reference: '17200001' + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + - id: '168350314' + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + totalAmount: 30 + currency: GBP + date: '2019-01-03T00:00:00' + note: �30.00 - Bill payment against Test123 (A & J Fabtech Ltd) + lines: + - amount: 30 + links: + - type: Bill + id: '11224800' + amount: -30 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 89 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + - id: '18' + supplierRef: + id: '39' + accountRef: + id: '167679' + name: Cash + totalAmount: 15 + currency: USD + date: '2021-08-18T00:00:00' + note: Bill payment Ikea + lines: + - amount: 15 + links: + - type: Bill + id: '18' + amount: -15 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + - id: 159623-724 + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: -555.55 + currency: GBP + currencyRate: 1 + date: '2022-07-11T00:00:00' + lines: + - amount: -555.55 + links: + - type: PaymentOnAccount + id: '724' + amount: 555.55 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2022-07-11T09:41:02' + reference: 'Deposit #DEP25' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + - id: 84C2-1197705262 + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + accountRef: + id: '8000007E-1197732180' + name: CalOil Credit Card + totalAmount: 4050.98 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + lines: + - amount: 4050.98 + links: + - type: Bill + id: 84C2-1197705262 + amount: -4050.98 + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:06:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 214 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + - id: '25' + supplierRef: + id: '5' + supplierName: Callum McGinley + accountRef: + id: '63' + name: Business Bank Account + totalAmount: 5999.99 + currency: GBP + currencyRate: 1 + date: '2019-05-31T00:00:00' + lines: + - amount: 5999.99 + links: + - type: Bill + id: '24' + amount: -5999.99 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-31T12:55:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 126 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + - id: '159' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 742.5 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 742.5 + links: + - type: Bill + id: '28' + amount: -742.5 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + reference: '1068' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 191 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + - id: '45502' + supplierRef: + id: SDE001 + supplierName: S D Enterprises + totalAmount: 59 + currency: GBP + currencyRate: 1 + date: '2020-01-17T00:00:00Z' + note: pay3 + lines: + - amount: 59 + links: + - type: PaymentOnAccount + id: SDE001 + amount: -59 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: payment inv3 + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '256' + supplierRef: + id: QUA001 + supplierName: Quality Motors + totalAmount: 256.36 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 256 linked to, purchase invoice 17.' + lines: + - amount: 256.36 + links: + - type: Bill + id: '17' + amount: -256.36 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 27 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + - id: a99b9aae216111e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a3e4bc6267a11e797950a57719b2edb + name: Cash + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-03-06T00:00:00' + note: Supplier payment using cash + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2018-03-06T17:13:17Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2225 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + - id: '4472' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 5 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 5 + links: + - type: Bill + id: '4470' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:06:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection. + + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-bill-payments + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/billPayments/{billPaymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillPaymentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayment' + examples: + Clear Books: + value: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + Exact (UK): + value: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + FreeAgent: + value: + id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + QuickBooks Desktop: + value: + id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + QuickBooks Online Sandbox: + value: + id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + Sage 50 (UK): + value: + id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + Sage Intacct: + value: + id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill payment + description: | + The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. + + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-payment + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/bills': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bills + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBills' + examples: + Clear Books: + value: + results: + - id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + - id: acc1dc9d-a21a-41b8-953e-73da4afab6e6 + reference: d88e83b8-a5cc-4578-815d-afa263df4beb + supplierRef: + id: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + purchaseOrderRefs: + - id: 7f07b584-bebe-450f-aa9e-1d7aed630b66 + purchaseOrderNumber: ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + issueDate: '2022-04-30T00:00:00' + dueDate: '2022-05-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 4 + discountAmount: 0 + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-04-14T01:56:02' + note: Bill for purchase order ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + paymentAllocations: + - payment: + id: a4fa017a-3911-4eb0-aaf9-b002c446c8c3 + note: Bill Payment against bill acc1dc9d-a21a-41b8-953e-73da4afab6e6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-15T00:00:00' + totalAmount: 418.35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-15T00:00:00' + totalAmount: -418.35 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 183 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + - id: b9cb06bf-89d1-ea11-bbaa-000d3a2b9185-108001 + reference: '108001' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 0 + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + discountPercentage: 0 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + amountDue: 0 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:02Z' + note: '107001' + paymentAllocations: + - payment: + id: 57377f05-8ad1-ea11-bbaa-000d3a2b9185 + note: Invoice 107001 + reference: '108001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-01T00:00:00' + totalAmount: 2431.68 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + totalAmount: -2431.68 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 294 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - id: ec0c61a1-deb6-4496-b9ee-feb29b16019c + reference: '19600008' + supplierRef: + id: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 12.1 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:39Z' + paymentAllocations: + - payment: + id: ef5d140b-16da-4fd2-a0c8-d5bfb89a13ee + reference: '19900056' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: b69e7ad4-2b90-4a5f-a8a0-67418ac95531 + reference: '19900053' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.2 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.2 + - payment: + id: 6ccd1256-6073-4bfc-8d88-700417685e72 + reference: '21200028' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-10-05T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - payment: + id: 69a8533b-3e59-4d2d-9bca-bc37bc0f7984 + reference: '19900055' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: 2dae3548-ff11-4ad8-886c-eb5cb7965024 + reference: '19900054' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + pageNumber: 1 + pageSize: 2 + totalResults: 80 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + - id: 064fbab9-9b4d-4e83-b2df-0f4ce12bc2bf + reference: '19600001' + supplierRef: + id: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + purchaseOrderRefs: [] + issueDate: '2019-01-11T00:00:00Z' + dueDate: '2019-02-10T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Basket balls + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '23' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T12:03:31Z' + paymentAllocations: + - payment: + id: d871f677-c2df-4069-bda0-c6804a46b71b + reference: '19200001' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2019-02-10T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '16609589' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:50:41Z' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 137 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '29' + supplierRef: + id: '89' + purchaseOrderRefs: [] + issueDate: '2021-04-28T00:00:00' + dueDate: '2021-05-28T00:00:00' + currency: GBP + lineItems: + - description: Advertising refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-08-18T13:52:33' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + - id: '76144089' + reference: '1' + supplierRef: + id: '6202387' + supplierName: Dell + purchaseOrderRefs: [] + issueDate: '2019-01-28T00:00:00' + dueDate: '2019-02-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 120 + quantity: 5 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '95293985' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + - id: '165372' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2022-07-15T00:00:00' + dueDate: '2022-07-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 555.78 + quantity: 1 + subTotal: 555.78 + totalAmount: 555.78 + accountRef: + id: '844' + name: Asset account test 2 + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 555.78 + taxAmount: 0 + totalAmount: 555.78 + amountDue: 500 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-15T11:35:47' + paymentAllocations: + - payment: + id: '165373' + reference: 'Bill Payment #2' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2022-07-15T00:00:00' + totalAmount: 555.78 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -55.78 + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Cabinets:Light Pine - Light pine kitchen cabinet wall unit + #CLD- 1235-p + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + metadata: + isDeleted: false + - id: 5CAB-1197713763 + reference: '8374892' + supplierRef: + id: 30000-933272656 + supplierName: C. U. Electric + purchaseOrderRefs: [] + issueDate: '2022-12-15T00:00:00' + dueDate: '2024-01-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 532 + quantity: 1 + discountAmount: 0 + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + discountPercentage: 0 + accountRef: + id: 490000-933270542 + name: Gas and Electric + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + categoryRefs: + - id: 80000007-1197713802 + name: Overhead + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E42-1182131999 + reference: '113' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 532 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -532 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: '22' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + pageNumber: 1 + pageSize: 2 + totalResults: 147 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + - id: '28' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-06T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: promotional items -- misc engraved items + unitAmount: 8.25 + quantity: 75 + discountAmount: 0 + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '59' + companyName: Ecker Holiday event + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + paymentAllocations: + - payment: + id: '159' + reference: '1068' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 742.5 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -742.5 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 711 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + - id: '45131' + reference: Order 2 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-03-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 31.6 + totalAmount: 31.6 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 158 + taxAmount: 0 + totalAmount: 158 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 158 + taxAmount: 31.6 + totalAmount: 189.6 + amountDue: 179.1 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No2 + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10.5 + pageNumber: 1 + pageSize: 2 + totalResults: 162 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + - id: '93' + reference: '2570' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-15T00:00:00' + dueDate: '2022-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 1175 + quantity: 1 + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1175 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 95 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: 09034445789211e8aaa5027d54329956 + reference: '25/06/2018 - 1,000.00' + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + purchaseOrderRefs: [] + issueDate: '2018-06-25T00:00:00' + dueDate: '2018-07-25T00:00:00' + currency: USD + currencyRate: 0.752601305 + lineItems: + - description: Bagels + unitAmount: 1000 + quantity: 1 + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + amountDue: 0 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2022-02-22T13:48:56Z' + paymentAllocations: + - payment: + id: 66d010243e3441ba89a793446eb9c74b + note: Supplier payment using credit/debit card - Test note + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.734679838 + paidOnDate: '2022-02-16T00:00:00' + totalAmount: 1000 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -1000 + pageNumber: 1 + pageSize: 2 + totalResults: 4658 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + metadata: + isDeleted: false + - id: '4705' + reference: JohnAndRob + supplierRef: + id: '8' + supplierName: Worldwide Commercial + purchaseOrderRefs: [] + issueDate: '2022-02-04T00:00:00' + dueDate: '2022-02-19T00:00:00' + currency: USD + currencyRate: 14 + lineItems: + - description: Some text for a description + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '49' + name: EC Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 10 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-22T12:24:59' + note: Some note on my bill + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=2&pageSize=2 + Xero: + value: + results: + - id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + - id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2022-01-17T00:00:00' + dueDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:06:22' + paymentAllocations: + - payment: + id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + - id: '104957000000152067' + reference: '2' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 12 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-11-04T13:07:23' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: list-accounting-bills + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/bills/{billId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBill' + examples: + Clear Books: + value: + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + Exact (UK): + value: + id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + FreeAgent: + value: + id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + FreshBooks: + value: + id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + KashFlow: + value: + id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + Oracle NetSuite: + value: + id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + QuickBooks Desktop: + value: + id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Cabinets:Light Pine - Light pine kitchen cabinet wall unit + #CLD- 1235-p + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + QuickBooks Online Sandbox: + value: + id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + Sage 50 (UK): + value: + id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + Sage Intacct: + value: + id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + metadata: + isDeleted: false + Xero: + value: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill + description: | + The *Get bill* endpoint returns a single bill for a given billId. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: get-accounting-bill + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-accounting-bill-attachments + x-speakeasy-group: accounts-payable.bills + summary: List bill attachments + description: | + The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill attachment + description: |- + The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: get-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download bill attachment + description: |- + The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: download-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/creditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + - id: d0d9b378-1d60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104002' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 779.28 + totalDiscount: 0 + subTotal: 649.4 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 129.88 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: 'Inv. No. 103222 - Shpt. No. 102222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: ATHENS Desk -pay with CR + unitAmount: 649.4 + quantity: 1 + discountAmount: 0 + subTotal: 649.4 + taxAmount: 129.88 + totalAmount: 779.28 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: c2942210-1e60-eb11-89fa-00224800a9c7 + note: Credit Memo 1002 + reference: 'Document No: 104002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-26T00:00:00' + totalAmount: 779.28 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:33:01Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + - id: '53604300' + creditNoteNumber: '2367' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 165 + status: Draft + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2022-09-29T13:00:09Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 281 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + - id: '33409' + creditNoteNumber: '0000066' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 300 + totalDiscount: 0 + subTotal: 300 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Draft + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 2 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054021' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '85326016' + creditNoteNumber: '5' + customerRef: + id: '69952389' + companyName: Things Limited + withholdingTax: [] + totalAmount: 1000 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '158675173' + unitAmount: 1 + quantity: -1000 + subTotal: -1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158675173' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86873915' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 400 + - payment: + id: '86874181' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + - payment: + id: '86874199' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -50 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 50 + - payment: + id: '86875655' + note: Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -750 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 750 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + - id: '8828' + creditNoteNumber: CM28 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '8828' + reference: 'Credit Memo #CM28' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-09T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 16 + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:37' + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes + QuickBooks Online: + value: + results: + - id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + - id: '86' + creditNoteNumber: '3122019_66' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 1 + totalDiscount: 0 + subTotal: 1 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Card + unitAmount: 1 + quantity: 1 + subTotal: 1 + taxAmount: 0 + totalAmount: 1 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '86' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -1 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 1 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1253 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + - id: '213' + creditNoteNumber: '1030' + customerRef: + id: '5' + companyName: Whitehead and Sons + withholdingTax: [] + totalAmount: 600 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 100 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-12-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee celebration -- Anniversary / Retirement + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 100 + totalAmount: 600 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '4' + name: Employee Celebration + trackingCategoryRefs: + - id: DEPARTMENT_3 + name: Birmingham + isDirectIncome: false + paymentAllocations: + - payment: + id: '215' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2018-12-18T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 600 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2018-12-18T10:08:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + - id: '45901' + creditNoteNumber: return 003 + customerRef: + id: ABS001 + companyName: ABS Garages Ltd + withholdingTax: [] + totalAmount: 177.14 + totalDiscount: 4.42 + subTotal: 147.62 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 29.52 + discountPercentage: 2.5 + remainingCredit: 177.14 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.73 + subTotal: 0 + taxAmount: 29.52 + totalAmount: 29.52 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 4.42 + subTotal: 147.62 + taxAmount: 0 + totalAmount: 147.62 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: cred 003 + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + - id: INV-34 + creditNoteNumber: '34' + customerRef: + id: MIL001 + companyName: Mile Road Health Centre + withholdingTax: [] + totalAmount: 1668.14 + totalDiscount: 0 + subTotal: 1425 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 243.14 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 6 + unitAmount: 1668.14 + quantity: 1 + subTotal: 1425 + taxAmount: 243.14 + totalAmount: 1668.14 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '530' + note: Sales credit inv-34 linked to sales invoice inv-26. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-28T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1668.14 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 6 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + - id: 28a459069a6211e8bad90617b3da4b8a + creditNoteNumber: SCN-3 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 5400 + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-08-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 28a459069a6211e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5400 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2018-08-07T16:51:41Z' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 2972 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + - id: '5020' + creditNoteNumber: ARADJ0034 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 115 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 15 + discountPercentage: 0 + remainingCredit: 115 + status: Submitted + issueDate: '2022-03-16T00:00:00' + currency: ZAR + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 15 + totalAmount: 115 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '28' + name: Standard Rate (Capital Goods) Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:30:19' + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes + Xero: + value: + results: + - id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + - id: caba470e-962f-4168-9c57-35caa289204d + creditNoteNumber: CN-0026 + customerRef: + id: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + companyName: Boom FM + withholdingTax: [] + totalAmount: 500 + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2023-01-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "CREDIT Half day training - Microsoft Office and include in suite of training\r\nINV-0024" + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: + - id: b3900cc6-3745-40ea-955f-9ef7b1c8cf7e + name: South + isDirectIncome: false + paymentAllocations: + - payment: + id: caba470e-962f-4168-9c57-35caa289204d + reference: Training + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-13T00:00:00' + totalAmount: 500 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T02:47:04' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + - id: '104957000000134023' + creditNoteNumber: CN-00002 + customerRef: + id: '104957000000054050' + companyName: 'Doe, John' + withholdingTax: [] + totalAmount: 125 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-05-06T13:04:20' + currency: GBP + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000134039' + currency: GBP + paidOnDate: '2020-05-06T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 125 + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-05-06T13:05:27' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection. + + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-credit-notes + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/creditNotes/{creditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: creditNoteId + in: path + required: true + schema: + type: string + description: Unique identifier for a credit note. + get: + tags: + - Accounts receivable + summary: Get credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + KashFlow: + value: + id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + QuickBooks Desktop: + value: + id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + QuickBooks Online Sandbox: + value: + id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + Sage 50 (UK): + value: + id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + Sage Intacct: + value: + id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + - id: LOCATION-10 + name: South Africa + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + Xero: + value: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get credit note* endpoint returns a single credit note for a given creditNoteId. + + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-credit-note + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/customers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List customers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomers' + examples: + Clear Books: + value: + results: + - id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + contactName: Miguel Hahn + emailAddress: contact@BreitenbergEmardandSchiller.biz + defaultCurrency: GBP + phone: 0800 445 6957 + addresses: + - type: Billing + line1: Apt. 184 + line2: 60578 Louie Springs + city: East Khalid + region: Wales + country: United Kingdom + postalCode: XW89 7NT + contacts: + - name: Miguel Hahn + email: Miguel.Hahn@gmail.com + phone: + - number: 018555 09614 + type: Landline + address: + type: Delivery + line1: Suite 400 + line2: 21930 Milan Lane + city: Reingerton + region: Wales + country: United Kingdom + postalCode: QG10 2DL + status: Active + registrationNumber: KME0AMIL + taxNumber: '8560920952.553111' + status: Archived + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-12-03T11:05:01' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-06-03T08:48:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 + customerName: anna test 2 + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-05-24T11:53:21Z' + pageNumber: 1 + pageSize: 2 + totalResults: 71 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c + customerName: Abdulbasit Al-haj + contactName: abeee + emailAddress: a.alhaj@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + country: GB + contacts: + - name: abeee + phone: [] + address: + type: Unknown + line1: '' + country: 'GB ' + status: Active + modifiedDate: '2020-02-24T12:00:51.027Z' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-24T12:00:50Z' + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + - id: '9677150' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-24T06:19:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: 1234 56789 + type: Primary + - number: 9876 54321 + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + - id: '634486' + customerName: A test customer name 2 + contactName: test person name + emailAddress: test8@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test9@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test10@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test8@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-11T11:39:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: '88459410' + customerName: Diogo Sousa + contactName: Mr Diogo Sousa + emailAddress: diogomail@mail.com + phone: '123123123' + addresses: + - type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + - type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + contacts: + - name: Mr Diogo Sousa + email: diogomail@mail.com + phone: + - number: '123123123' + type: Landline + - number: '321321321' + type: Mobile + address: + type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + status: Active + - name: Mr Diogo Sousa + phone: [] + address: + type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2021-05-04T13:22:19' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + - id: '172722' + customerName: 1248 European Company + contactName: European Company + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-07-27T14:29:16' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + - id: 800000D0-1182061376 + customerName: 'Allard, Robert' + contactName: Amanda Roberts + emailAddress: rallard@myemail.com + defaultCurrency: GBP + phone: 650-555-3422 + addresses: + - type: Delivery + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + - type: Billing + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + contacts: + - name: 'Allard, Robert' + email: rallard@myemail.com + 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 + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + - id: '49' + customerName: adeel qbo child test + contactName: Adeel test + emailAddress: adeel@adeel.com + defaultCurrency: GBP + phone: '123456789' + addresses: + - type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + - type: Delivery + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + contacts: + - name: Adeel test + email: adeel@adeel.com + phone: + - number: '123456789' + type: Primary + - number: '07546543216' + type: Mobile + address: + type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + status: Active + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-08-22T09:21:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + - id: '67' + customerName: Abercrombie International Group + contactName: Natalie Watts + emailAddress: n.watts@google.com + defaultCurrency: USD + addresses: + - type: Billing + - type: Delivery + contacts: + - name: Abercrombie International Group + email: n.watts@google.com + phone: [] + address: + type: Billing + status: Active + registrationNumber: XXXXVat123456 + taxNumber: XXXXVat123456 + status: Active + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2023-03-29T01:12:55Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 243 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + - id: A1D002 + customerName: A2 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Billing + line1: 77a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 40 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2020-09-23T10:28:58Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + - id: ABS001 + customerName: ABS Garages Ltd + contactName: Mike Hall + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 0191 254 5909 + addresses: + - type: Delivery + line1: Swanson Industries + line2: Dukes Industrial Estate + city: Whitley Bay + region: North Tyneside + country: GB + postalCode: NE56 4ER + - type: Delivery + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + - type: Unknown + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + contacts: [] + taxNumber: GB745 4584 68 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + - id: 44a5d9461d9e4f6d90a5ace251c5cf35 + customerName: 100 test name DS + contactName: Main Contact + emailAddress: DCemail@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: POST - Aruba Address line 1 + line2: POST - Aruba Address line 2 + city: POST - Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: [] + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-06-10T14:22:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 168 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + - id: '324' + customerName: 3Way International Logistics + contactName: Lauri O'Heagertie + defaultCurrency: CAD + phone: 410-309-3976 + addresses: + - type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + contacts: + - name: 'O''Heagertie, Lauri' + phone: + - number: 410-309-3976 + type: Primary + address: + type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2020-10-20T05:01:49' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 530 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 + customerName: Coffee Cart + contactName: Coffee Carl + emailAddress: coffee.cart@example.com + defaultCurrency: GBP + phone: '0201111' + addresses: + - type: Billing + line1: 11 Coffee Lane + line2: Coffee Town + city: Coffee City + region: Hampshire + country: United Kingdom + postalCode: CC1 1CC + contacts: + - name: Coffee Carl + phone: + - number: '07733' + type: Mobile + status: Active + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2020-03-17T19:12:39Z' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + customerName: 7-Eleven + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + - id: '104957000000054050' + customerName: 'Doe, John' + contactName: John Doe + emailAddress: '' + defaultCurrency: GBP + addresses: [] + contacts: + - name: John Doe + email: '' + phone: [] + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-28T15:09:22' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-customers + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/data/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + summary: Get customer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomer' + examples: + Clear Books: + value: + id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + Exact (UK): + value: + id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + FreeAgent: + value: + id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + KashFlow: + value: + id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Oracle NetSuite: + value: + id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + QuickBooks Desktop: + value: + id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + QuickBooks Online Sandbox: + value: + id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + Sage 50 (UK): + value: + id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + Sage Intacct: + value: + id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-customer + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List customer attachments + description: |- + The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: list-accounting-customer-attachments + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get customer attachment + description: | + The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: get-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download customer attachment + description: |- + The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: download-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List direct costs + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCosts' + examples: + Clear Books: + value: + results: + - id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + - id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: 7d011ce8-89ae-43e7-a2ed-cf028534ccdc + note: 'Direct Cost with 4 line items, totaling 13684.57' + contactRef: + id: d3tf43eghS + dataType: suppliers + issueDate: '2022-05-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 148.88 + quantity: 5 + discountAmount: 73.62 + discountPercentage: 9.89 + subTotal: 670.78 + taxAmount: 67.08 + totalAmount: 737.86 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 82.68 + quantity: 3 + discountAmount: 0 + discountPercentage: 0 + subTotal: 248.04 + taxAmount: 24.8 + totalAmount: 272.84 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1192.51 + quantity: 8 + discountAmount: 0 + discountPercentage: 0 + subTotal: 9540.08 + taxAmount: 954.01 + totalAmount: 10494.09 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 9 + discountAmount: 0 + discountPercentage: 0 + subTotal: 1981.62 + taxAmount: 198.16 + totalAmount: 2179.78 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: + - id: costcode_1 + name: Green Concrete + paymentAllocations: + - payment: + id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + note: Payment for direct cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: Direct Cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-02T00:00:00' + totalAmount: 13684.57 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-02T00:00:00' + totalAmount: -13684.57 + subTotal: 12440.52 + taxAmount: 1244.05 + totalAmount: 13684.57 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-10-13T07:15:02' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + - id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + reference: INS000050 + note: '3915' + issueDate: '2022-05-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Utilities Expense + accountRef: + id: '31300' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 14.76 + quantity: 1 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T15:26:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 67 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + - id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:35:29Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 456 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + - id: '107509561' + reference: Buying pencils + note: Buying pencils + contactRef: + id: Pencils Wholesale + dataType: suppliers + issueDate: '2020-01-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Buying pencils + accountRef: + id: '3380551' + name: Supplies + unitAmount: 43.48 + quantity: 1 + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + trackingCategoryRefs: + - id: '5397997' + name: Supplies + paymentAllocations: [] + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:47' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + reference: '95' + contactRef: + id: 320000-933272659 + dataType: suppliers + issueDate: '2022-12-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 280000-933270542 + name: Freight & Delivery + unitAmount: 35 + quantity: 1 + subTotal: 35 + totalAmount: 35 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + tracking: + recordRefs: + - id: 40000-933272658 + dataType: trackingCategories + - id: 1E0000-933272658 + dataType: customers + paymentAllocations: + - payment: + id: DFA-933785132 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 250 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: PUR-3617 + reference: '2001' + contactRef: + id: '27' + dataType: suppliers + issueDate: '2015-11-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Insurance - general liability + accountRef: + id: '22' + name: Insurance Expense-General Liability Insurance + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + unitAmount: 750 + quantity: 1 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '3617' + note: '2001' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-27T00:00:00' + totalAmount: 900 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-27T00:00:00' + totalAmount: -900 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2022-08-19T10:19:56Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4460 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + - id: PUR-9303 + note: Payment to Google + contactRef: + id: '4' + dataType: suppliers + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '9303' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2022-07-11T10:32:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2176 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '52' + reference: '568953' + issueDate: '2021-01-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Vat Payment Quater End 3112.96 + accountRef: + id: '2202' + name: VAT Liability + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + unitAmount: 1497.58 + quantity: 1 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '52' + reference: '568953' + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 106 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + - id: 'CCTRANSACTION:4356' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62022' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4356' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-02-17T23:26:16' + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=2&pageSize=2 + Xero: + value: + results: + - id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + - id: 521c2396-7f74-404c-9cca-31115296b808 + reference: Eft + contactRef: + id: 74ea95ea-6e1e-435d-9c30-0dff8ae1bd80 + dataType: suppliers + issueDate: '2022-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Misc stationery + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + unitAmount: 18.09 + quantity: 1 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 521c2396-7f74-404c-9cca-31115296b808 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:51' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-direct-costs + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost' + examples: + Clear Books: + value: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + Sage 50 (UK): + value: + id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Intacct: + value: + id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + Xero: + value: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct cost* endpoint returns a single direct cost for a given directCostId. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-cost + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: get-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Download direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: download-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: List direct cost attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: list-accounting-direct-cost-attachments + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directIncomes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: List direct incomes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncomes' + examples: + Clear Books: + value: + results: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: ee4ea56f-8806-494d-9c69-7ec22e68dc5e + note: 'Direct Income with 4 line items, totaling 32095.91' + contactRef: + id: 453ddfc0-49ce-4f66-a815-dae734be885c + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 95.08 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 190.16 + taxAmount: 19.02 + totalAmount: 209.18 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + - id: department_3 + name: MarshallBrotherContracting + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1251.89 + quantity: 6 + discountAmount: 778.93 + discountPercentage: 10.37 + subTotal: 6732.41 + taxAmount: 673.24 + totalAmount: 7405.66 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 5563.88 + taxAmount: 556.39 + totalAmount: 6120.27 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 6 + discountAmount: 0 + discountPercentage: 0 + subTotal: 16691.64 + taxAmount: 1669.16 + totalAmount: 18360.8 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + note: Payment for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: Direct Income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 32095.91 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -32095.91 + subTotal: 29178.09 + taxAmount: 2917.81 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 518 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + - id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + reference: B110 + note: '4990' + issueDate: '2023-03-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Accounts Receivable + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 649.4 + quantity: -1 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + accountRef: + id: b6545a08-a9bd-ed11-9a88-0022484358c7 + name: HOLDING_LENDING + currency: GBP + currencyRate: 1 + paidOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-03-08T13:55:34Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes + FreeAgent: + value: + results: + - id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + - id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: '001' + name: Sales + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:13:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 211 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + - id: 68E0-1197775239 + reference: 96F3-1197775718 + contactRef: + id: 800000B5-1197701259 + dataType: customers + issueDate: '2023-01-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 361.08 + quantity: 1 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 68E0-1197775239 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-17T00:00:00' + totalAmount: 15281.67 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-17T00:00:00' + totalAmount: 361.08 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 104 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + - id: 5-2 + contactRef: + id: '53' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: funds borrowed to start business + accountRef: + id: '63' + name: Note Payable + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 25000 + quantity: 1 + discountAmount: 0 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-2 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 25000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -25000 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 741 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '11' + note: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + issueDate: '2018-10-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + accountRef: + id: '57' + name: Sales of Product Income + unitAmount: 8.12 + quantity: 1 + discountAmount: 0 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '11' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-10-15T00:00:00' + totalAmount: 8.12 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-10-15T00:00:00' + totalAmount: -8.12 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1171 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + - id: '5314' + reference: Test Int Income + note: Test Description + issueDate: '2022-03-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Interest earned + accountRef: + id: '5' + name: Other Income + unitAmount: 300 + quantity: 1 + subTotal: 300 + totalAmount: 300 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '5314' + note: Test Description + reference: Test Int Income + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + allocation: + currency: GBP + allocatedOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + modifiedDate: '2022-10-28T11:10:26Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=2&pageSize=2 + Xero: + value: + results: + - id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-direct-incomes + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: Get direct income + parameters: + - $ref: '#/components/parameters/accountingDirectIncomeId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncome' + examples: + Clear Books: + value: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Sage Intacct: + value: + id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + Xero: + value: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct income* endpoint returns a single direct income for a given directIncomeId. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-income + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Get direct income attachment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: get-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Download direct income attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: download-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + get: + tags: + - Accounts receivable + summary: List direct income attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: list-accounting-direct-income-attachments + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/data/info': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get company accounting profile + description: Gets the latest basic info for a company. + operationId: get-accounting-profile + x-speakeasy-name-override: get-accounting-profile + tags: + - Company info + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + accountingPlatformRef: 1700060034_ETD + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + taxNumber: '74111622555799035846' + financialYearStartDate: '2023-04-01T00:00:00' + baseCurrency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2020-03-09T15:19:26' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List invoices + description: | + The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Useful queries + + - Outstanding invoices - `query = amountDue > 0` + - Invoices due after a certain date: `query = dueDate > 2021-01-28` + + [Read more about querying](https://docs.codat.io/using-the-api/querying). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + operationId: list-accounting-invoices + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoices' + examples: + Clear Books: + value: + results: + - id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + invoiceNumber: 4F6ONfFP + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-08-22T07:43:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x8.28 + unitAmount: 402.89 + quantity: 8.28 + subTotal: 3335.93 + taxAmount: 333.59 + totalAmount: 3669.52 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 3669.52 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -3669.52 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3335.93 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 333.59 + totalAmount: 3669.52 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 142 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: 31e97827-bb18-ed11-90eb-000d3a8747a0 + invoiceNumber: '102287' + customerRef: + id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + companyName: '' + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-08-10T14:46:08Z' + currency: USD + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + discountPercentage: 0 + status: Draft + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 368 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + - id: 0078bc15-10a4-433d-86fa-b1bb235fc0ab + invoiceNumber: '19700004' + customerRef: + id: 46951dc4-a170-42ce-bb38-9a80b776404f + companyName: Cust 03 + salesOrderRefs: [] + issueDate: '2019-11-13T00:00:00Z' + dueDate: '2019-12-04T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-13T11:47:51Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Standaard artikel - Standaard artikel + unitAmount: 25 + quantity: 1 + discountAmount: 0 + subTotal: 25 + taxAmount: 5.25 + totalAmount: 30.25 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 25 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5.25 + totalAmount: 30.25 + amountDue: 30.25 + discountPercentage: 0 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 5844 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + - id: 0981b5d1-a817-40be-a101-4848f7b1a258 + invoiceNumber: '17700004' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-03T00:00:00Z' + dueDate: '2017-09-02T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-03T12:22:27Z' + paidOnDate: '2017-08-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 150 + discountAmount: 0 + subTotal: 15000 + taxAmount: 0 + totalAmount: 15000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 15000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 15000 + amountDue: 0 + discountPercentage: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 4214 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '21974783' + invoiceNumber: '023' + customerRef: + id: '6162023' + companyName: Alderley plc + salesOrderRefs: [] + issueDate: '2017-01-09T00:00:00' + dueDate: '2017-02-08T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2023-02-06T15:31:38Z' + paidOnDate: '2023-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Laptop + unitAmount: 500 + quantity: 22 + discountAmount: 0 + subTotal: 11000 + taxAmount: 0 + totalAmount: 11000 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2 + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '214509356' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214338075' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327399' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327371' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214672049' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671769' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671495' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671482' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671308' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167014' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '215687795' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167064' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-12-02T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256992092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991833' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987893' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987069' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256983353' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256982947' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256955690' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256953648' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216464177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453277' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453273' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168080' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '260537850' + note: E2E Test transaction 19 DEBIT �250.00 - E2 E Test Transaction 19 - E2 E Test Transaction 19 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2020-10-23T00:00:00' + totalAmount: 235 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -225 + - payment: + id: '413909805' + note: �1.00 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2023-02-06T00:00:00' + totalAmount: 1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + subTotal: 11000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 11000 + amountDue: 10766.74 + status: PartiallyPaid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1449 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + - id: '2396753' + invoiceNumber: '0000062' + customerRef: + id: '512927' + companyName: Wood Turnerss + salesOrderRefs: [] + issueDate: '2016-04-04T00:00:00' + dueDate: '2016-04-04T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-02-24T07:34:31' + currency: GBP + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Submitted + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 172 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + - id: '143008597' + invoiceNumber: '41' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2010-01-01T00:00:00' + dueDate: '2010-01-29T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + paidOnDate: '2020-11-03T00:00:00' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '146438947' + note: '' + currency: EUR + paidOnDate: '2020-11-03T00:00:00' + totalAmount: 0 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: 0 + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 37 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + - id: '8529' + invoiceNumber: INV63 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2022-02-24T13:51:58' + paidOnDate: '2022-09-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '17588' + note: Payment Example - Invoice allocation + reference: 'Payment #PYMT90' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 10 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '17589' + note: Example - Payment of an invoice + reference: 'Payment #PYMT91' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '24558' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT109' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + - payment: + id: '24659' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT111' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + withholdingTax: [] + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 26 + amountDue: 5.8 + status: PartiallyPaid + pageNumber: 1 + pageSize: 2 + totalResults: 107 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: '469E-1071530054' + invoiceNumber: '978' + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + salesOrderRefs: [] + issueDate: '2022-11-30T00:00:00' + dueDate: '2023-12-30T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:09' + paidOnDate: '2023-01-10T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: See attached specification for details on work below. + unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Installation labor + unitAmount: 45.5 + quantity: 1 + subTotal: 45.5 + taxAmount: 0 + totalAmount: 45.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 20000-933272655 + name: Installation + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install drywall + unitAmount: 1320 + quantity: 1 + subTotal: 1320 + taxAmount: 0 + totalAmount: 1320 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 70000-933272656 + name: 'Subs:Drywall' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Electrical work + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 80000-933272656 + name: 'Subs:Electrical' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Metal Work + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: A0000-933272656 + name: 'Subs:Metal Wrk' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install insulation + unitAmount: 1100 + quantity: 1 + subTotal: 1100 + taxAmount: 0 + totalAmount: 1100 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 90000-933272656 + name: 'Subs:Insulating' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Plumbing + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: C0000-933272656 + name: 'Subs:Plumbing' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Painting + unitAmount: 2420 + quantity: 1 + subTotal: 2420 + taxAmount: 0 + totalAmount: 2420 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: B0000-933272656 + name: 'Subs:Painting' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install carpeting + unitAmount: 3300 + quantity: 1 + subTotal: 3300 + taxAmount: 0 + totalAmount: 3300 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 60000-933272656 + name: 'Subs:Carpet' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Custom Bay Window + unitAmount: 1925 + quantity: 1 + subTotal: 1925 + taxAmount: 0 + totalAmount: 1925 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Window + unitAmount: 115.5 + quantity: 1 + subTotal: 115.5 + taxAmount: 0 + totalAmount: 115.5 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Equipment Rental + unitAmount: 700 + quantity: 1 + subTotal: 700 + taxAmount: 0 + totalAmount: 700 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 230000-933272656 + name: Equip Rental + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: 10% retainage to be billed after job is complete and approved. + unitAmount: -555.5 + quantity: 1 + subTotal: -555.5 + taxAmount: 0 + totalAmount: -555.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 260000-933272656 + name: Retainage 1 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 6915-1197775450 + note: Check - 80000-933270541 + reference: '19650' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-10T00:00:00' + totalAmount: 14488.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14488.64 + withholdingTax: [] + totalDiscount: 0 + subTotal: 14330.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 158.14 + totalAmount: 14488.64 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + - id: '17' + invoiceNumber: '1002' + customerRef: + id: '2' + companyName: Software Coperation + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2019-02-21T17:51:49Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: IT Support + unitAmount: 80 + quantity: 40 + subTotal: 3200 + taxAmount: 0 + totalAmount: 3200 + accountRef: + id: '1' + name: Sales + itemRef: + id: '2' + name: Hours + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 3200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 3200 + amountDue: 3200 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 1326 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '3793' + invoiceNumber: 276e29c1 + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2022-08-22T13:04:50Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 15615 + status: Submitted + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1077 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + - id: '83515' + invoiceNumber: '0000000111' + customerRef: + id: BRO001 + companyName: Bronson Inc + salesOrderRefs: [] + issueDate: '2020-07-15T00:00:00Z' + dueDate: '2020-08-29T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-15T10:45:56Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Zero rated + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + taxRateRef: + id: '1728' + name: Zero rated + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 3.13 + subTotal: 125 + taxAmount: 0 + totalAmount: 125 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 3.13 + subTotal: 125 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 125 + amountDue: 125 + discountPercentage: 2.5 + status: Submitted + note: '0000000111' + pageNumber: 1 + pageSize: 2 + totalResults: 409 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: INV-9 + invoiceNumber: '9' + customerRef: + id: KIN001 + companyName: Kinghorn & French + salesOrderRefs: [] + issueDate: '2021-01-04T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 765 + quantity: 5 + discountAmount: 765 + subTotal: 3060 + taxAmount: 522.11 + totalAmount: 3582.11 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 5 + unitAmount: 1080 + quantity: 4 + discountAmount: 864 + subTotal: 3456 + taxAmount: 589.68 + totalAmount: 4045.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 6 + unitAmount: 1350 + quantity: 2 + discountAmount: 540 + subTotal: 2160 + taxAmount: 368.55 + totalAmount: 2528.55 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: FX030 Multifunctional Fax + unitAmount: 414 + quantity: 2 + discountAmount: 165.6 + subTotal: 662.4 + taxAmount: 113.02 + totalAmount: 775.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Premium Grade + unitAmount: 3.06 + quantity: 100 + discountAmount: 61.2 + subTotal: 244.8 + taxAmount: 41.77 + totalAmount: 286.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -276.57 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -765.42 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4035.68 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2518.55 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3527.11 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '9' + note: Sales credit tx-9 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -45 + withholdingTax: [] + totalDiscount: 2395.8 + subTotal: 9583.2 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1635.13 + totalAmount: 11218.33 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 86 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + - id: 6420b3f8209611e8b45c025132dab352 + invoiceNumber: SI-2 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2018-03-05T00:00:00' + dueDate: '2018-04-04T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2018-03-05T16:58:39Z' + paidOnDate: '2018-03-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 73a0490d209611e8b45c025132dab352 + note: Customer receipt using cash - PAYMENT-CASH-001 + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-03-05T00:00:00' + totalAmount: 5400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5400 + withholdingTax: [] + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + totalAmount: 5400 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 10759 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '18827' + invoiceNumber: IN1515 + customerRef: + id: '6' + companyName: AG Insurance + salesOrderRefs: [] + issueDate: '2022-09-28T00:00:00' + dueDate: '2022-10-28T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2022-10-05T11:02:22Z' + currency: USD + currencyRate: 0.9294 + lineItems: + - description: test desc Test05102022-1 + unitAmount: 180 + quantity: 1 + subTotal: 180 + taxAmount: 0 + totalAmount: 180 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '58' + name: EC Sale Goods Standard Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: CUSTOMER-6 + name: AG Insurance + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 180 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 180 + amountDue: 180 + status: Submitted + note: test desc Test05102022-1 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6ODgzOTc4MDA2NDIxMzUwODIx + invoiceNumber: '2' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM2OTkxOTYw + companyName: NIC Cookies + salesOrderRefs: [] + issueDate: '2020-03-05T00:00:00' + dueDate: '2020-03-05T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2020-03-30T14:10:21Z' + paidOnDate: '2020-03-30T14:10:21Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Decorated cookies + unitAmount: 4 + quantity: 50 + subTotal: 200 + taxAmount: 40 + totalAmount: 240 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6NDEzNzEwOTU= + name: Cookies + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 40 + totalAmount: 240 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=2&pageSize=2 + Xero: + value: + results: + - id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + invoiceNumber: INV-0001 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + salesOrderRefs: [] + issueDate: '2022-02-07T00:00:00' + dueDate: '2022-02-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T22:51:43' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Retainer for consulting work + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + reference: '' + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 500 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -500 + withholdingTax: [] + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + totalAmount: 500 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + - id: '104957000000038052' + invoiceNumber: INV-104 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:04' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-02-17T14:21:05' + paidOnDate: '2020-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000070175' + note: Cheque deposit + reference: '4' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 9001 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9001 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices/{invoiceId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoice' + examples: + Clear Books: + value: + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + Exact (UK): + value: + id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + FreeAgent: + value: + id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + FreshBooks: + value: + id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + KashFlow: + value: + id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + Oracle NetSuite: + value: + id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + QuickBooks Desktop: + value: + id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + QuickBooks Online Sandbox: + value: + id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + Sage 50 (UK): + value: + id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + Sage Intacct: + value: + id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + Xero: + value: + id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice + description: | + The *Get invoice* endpoint returns a single invoice for a given invoiceId. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + operationId: get-accounting-invoice + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/invoices/{invoiceId}/pdf': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/pdf: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice as PDF + description: "\uFEFFDownload invoice as a pdf." + operationId: download-accounting-invoice-pdf + x-speakeasy-name-override: download-pdf + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List invoice attachments + description: |- + The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: list-accounting-invoice-attachments + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice attachment + description: | + The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: get-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download invoice attachment + description: | + The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: download-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/journalEntries': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journal entries + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntries' + examples: + Clear Books: + value: + results: + - id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + - id: 9f96606f-6846-40c6-b423-9b1753458e75 + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 188.33 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + netAmount: -17.12 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -171.21 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1862 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + - id: 01-2019 + postedOn: '2019-01-01T00:00:00' + createdOn: '2019-01-01T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: January 2019 + netAmount: -2000 + currency: GBP + accountRef: + id: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Checking account + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Salaries Expense + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Rent Expense + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 825 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + - id: 000154f0-e83a-4012-96a3-7db0b036b96b + createdOn: '2020-04-22T13:56:46' + updatedOn: '2020-04-22T13:56:46' + journalRef: + id: 151313ae-55b1-4ba0-b32a-e2ef6a8ce52a + name: Nominal Card + journalLines: + - description: Refunds with payment type of Cash + netAmount: -144.36 + currency: EUR + accountRef: + id: 0741cc89-e33a-4358-bcbd-3acb07b005dc + name: Nominal Card + tracking: + recordRefs: [] + - description: Refunds with payment type of Cash + netAmount: 144.36 + currency: EUR + accountRef: + id: ef2fde36-4416-4bc5-b239-315b2929348c + name: Debiteuren + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:08Z' + sourceModifiedDate: '2020-04-22T13:56:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 35972 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + - id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + createdOn: '2021-07-30T18:02:23' + updatedOn: '2021-07-30T18:02:23' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: 1038.01 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: cc0ab812-d89a-452b-88a8-61666a0f0211 + name: Accruals + tracking: + recordRefs: [] + - netAmount: -19.29 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - netAmount: -60.82 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 15.0 items with VatPercentage of 0.0 + netAmount: -248.28 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -8.97 + currency: GBP + accountRef: + id: 8f27a6b8-101d-4613-a059-2b462fb01b2f + name: anna_test_prod + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 5.0 + netAmount: -385.7 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 2 service charges with 0.0% vat + netAmount: -9.85 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 27.0 items with VatPercentage of 20.0 + netAmount: -304.1 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2021-07-30T18:02:23Z' + recordRef: + id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + dataType: invoices + pageNumber: 1 + pageSize: 2 + totalResults: 6785 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + - id: '24389396' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: -222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: 222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 734 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + - id: '7' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:02:18' + updatedOn: '2022-07-05T13:38:10' + journalLines: + - netAmount: -144 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '716' + name: Inventory In Transit + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - description: VAT + netAmount: 24 + currency: GBP + accountRef: + id: '211' + name: VAT on Purchases + tracking: + recordRefs: + - id: '713' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2022-07-05T13:38:10' + recordRef: + id: '7' + dataType: bills + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + - id: '469E-1071530054' + postedOn: '2022-11-30T00:00:00' + createdOn: '2022-11-30T00:00:00' + journalLines: + - description: '' + netAmount: 14488.64 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Installation labor + netAmount: -45.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: Install drywall + netAmount: -1320 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Electrical work + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Metal Work + netAmount: -660 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install insulation + netAmount: -1100 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Plumbing + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Painting + netAmount: -2420 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install carpeting + netAmount: -3300 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Custom Bay Window + netAmount: -1925 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -115.5 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Equipment Rental + netAmount: -700 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 10% retainage to be billed after job is complete and approved. + netAmount: 555.5 + currency: GBP + accountRef: + id: 70000-933270541 + name: Retainage Receivable + - description: 'CA sales tax, San Tomas County' + netAmount: -158.14 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:05:41' + recordRef: + id: '469E-1071530054' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Payment to Google + netAmount: -1.59 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: Payment to Google + netAmount: 1.59 + currency: GBP + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + recordRef: + id: PUR-15 + dataType: directCosts + pageNumber: 1 + pageSize: 2 + totalResults: 9405 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + - id: '13' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 7500 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: -7500 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:04Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9190 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + - id: '92' + description: Goods + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Goods/Services - Goods + netAmount: -5875 + currency: GBP + accountRef: + id: '2100' + name: Creditors Control Account + - description: Goods/Services - Goods + netAmount: 5000 + currency: GBP + accountRef: + id: '5000' + name: Materials Purchased + - description: Goods/Services - Goods + netAmount: 875 + currency: GBP + accountRef: + id: '2201' + name: Purchase Tax Control Account + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '92' + dataType: bills + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1119 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + - id: c23efa4233de11e797950a57719b2edb + postedOn: '2017-05-08T11:09:09' + createdOn: '2017-05-08T11:09:09' + updatedOn: '2017-05-08T11:09:09' + journalLines: + - netAmount: 1080 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + - description: Consulting services + netAmount: -180 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: -900 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:09:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24386 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + - id: '262179' + description: 'Receipts(Bank-501_CHK) - 1100: April 2021 Batch Summary Entry' + postedOn: '2021-04-30T00:00:00' + createdOn: '2021-04-22T11:01:11' + updatedOn: '2022-04-19T13:38:45' + journalRef: + id: '7' + name: Cash Receipts Journal + journalLines: + - description: '' + netAmount: -120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: 150 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: -150 + currency: GBP + accountRef: + id: '179' + name: Revenue - Other + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-19T13:38:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=2&pageSize=2 + Xero: + value: + results: + - id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + - id: 98ac5060-c9ed-4359-bcd5-711e649e7899 + postedOn: '2021-12-20T00:00:00' + createdOn: '2023-02-17T21:07:23' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + - description: '' + netAmount: 7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:23' + recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 290 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection. + + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-journal-entries + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journalEntries/{journalEntryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: journalEntryId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a journal entry. + get: + tags: + - Transactions + summary: Get journal entry + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntry' + examples: + Clear Books: + value: + id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + Exact (UK): + value: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + FreshBooks: + value: + id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + QuickBooks Desktop: + value: + id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + QuickBooks Online Sandbox: + value: + id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + Sage Intacct: + value: + id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + Xero: + value: + id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. + + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal-entry + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journals': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journals + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournals' + examples: + Clear Books: + value: + results: + - id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + - id: 07b94827-c0a5-4cc7-ba58-3f9efec3b4b3 + journalCode: PAY + name: Payroll Journal + type: Payroll Journal + parentId: 90bb7784-083b-4bcb-a534-b30756cee65d + hasChildren: false + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-24T14:17:02' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + Dynamics 365 Business Central: + value: + results: + - id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + - id: 9a94ef78-92ec-ec11-82f9-000d3a8746a9 + journalCode: BNKDEPOSIT-BNKD + name: BNKD + type: Bank Deposits + parentId: af7d7e6b-e5c8-ec11-8e7e-000d3a86e04a + hasChildren: false + createdOn: '2022-06-15T10:03:59' + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-15T22:45:30Z' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 46 + Exact (Netherlands): + value: + results: + - id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + - id: 74677165-1bd3-49b4-87d0-32d974674f86 + journalCode: '23' + name: Abraham's Billion Dollar stuff + type: Bank + hasChildren: false + createdOn: '2019-11-22T13:35:57' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2019-11-22T13:35:57Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 47 + Exact (UK): + value: + results: + - id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + - id: b9c3d6a6-4ce2-4714-9ff6-fb15892300f7 + journalCode: '31' + name: annaBankAccount10 + type: Bank + hasChildren: false + createdOn: '2021-05-18T10:24:18' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-05-18T10:24:18Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + Sage Intacct: + value: + results: + - id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + - id: '223' + journalCode: AJPT2 + name: A Journal Push Test 2 + type: '' + hasChildren: false + createdOn: '2022-01-18T15:39:07' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-18T15:39:07' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 1211 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection. + + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-journals + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/journals/{journalId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: Get journal + parameters: + - name: journalId + in: path + required: true + schema: + type: string + description: Unique identifier for a journal. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournal' + examples: + Clear Books: + value: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + Exact (UK): + value: + id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + Sage Intacct: + value: + id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal* endpoint returns a single journal for a given journalId. + + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/payments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayments' + examples: + Clear Books: + value: + results: + - id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + - id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + paymentMethodRef: + id: 8db2de81-0db4-46ee-b7f9-c711a7e89a01 + name: Cash payments-IHz + totalAmount: 1772.72 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + lines: + - amount: 1772.72 + links: + - type: Invoice + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + amount: -1772.72 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 200 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + - id: 042a9ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Adatum Corporation + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 600.48 + currency: GBP + currencyRate: 1 + date: '2019-01-16T00:00:00' + note: Invoice 102002 + lines: + - amount: 600.48 + links: + - type: Invoice + id: 1bc906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -600.48 + currencyRate: 1 + allocatedOnDate: '2019-01-16T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103002' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 249 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + - id: 1650bb9c-5d9a-40f2-9015-0e251a12f861_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 991.56 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 991.56 + links: + - type: Invoice + id: 013f05e6-2583-4e6d-8309-a479808cf7bf + amount: -991.56 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:12Z' + reference: '19230010' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + - id: d8b093cf-3d37-405b-9e85-72552226553f_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T09:58:15Z' + reference: '20200001' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + - id: '135258250' + customerRef: + id: '6162230' + companyName: Stronachs LLP + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 006' + lines: + - amount: 100 + links: + - type: Invoice + id: '21952246' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1146 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + - id: '988600' + customerRef: + id: '380630' + totalAmount: 5 + currency: GBP + date: '2019-01-21T00:00:00' + note: 'Overpayment: invoice #0000007' + lines: + - amount: 5 + links: + - type: PaymentOnAccount + id: '380630' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2019-01-21T10:23:59' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + - id: '86861497' + customerRef: + id: '69946501' + companyName: Peter Lord + totalAmount: 10 + currency: GBP + date: '2017-05-01T00:00:00' + note: '' + lines: + - amount: 10 + links: + - type: Invoice + id: '85315064' + amount: -10 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 2 + totalResults: 74 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + - id: '428' + customerRef: + id: '417' + companyName: 10 Breww Ltd + accountRef: + id: '122' + name: Undeposited Funds + totalAmount: 90 + currency: GBP + currencyRate: 1 + date: '2021-04-20T00:00:00' + lines: + - amount: 90 + links: + - type: Invoice + id: '416' + amount: -90 + currencyRate: 1 + - amount: 10 + links: + - type: Invoice + id: '416' + amount: -10 + currencyRate: 1 + - amount: -10 + links: + - type: Other + id: '428' + amount: 10 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-04-28T13:36:54' + reference: 'Payment #PYMT01' + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + - id: 6973-1197775625 + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 431.95 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 431.95 + links: + - type: Invoice + id: 2453-1071526256 + amount: -431.95 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '983409' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 108 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + - id: '9298' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Adeel Test + lines: + - amount: 95.2 + links: + - type: PaymentOnAccount + id: '9' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:18Z' + sourceModifiedDate: '2022-06-20T13:51:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3723 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + - id: '31' + customerRef: + id: '59' + companyName: Ecker Holiday event + accountRef: + id: '81' + name: Current + totalAmount: 15615 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 15615 + links: + - type: Invoice + id: '30' + amount: -15615 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2016-09-12T16:50:17Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 813 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + - id: '29681' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-12-31T00:00:00Z' + note: Opening Balance + lines: + - amount: 0 + links: + - type: Invoice + id: '29745' + amount: 0.05 + currencyRate: 1 + - type: CreditNote + id: '29681' + amount: -0.05 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: O/BAL + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '8' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + accountRef: + id: '' + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-12-31T00:00:00' + note: Sales credit tx-8 linked to sales invoice inv-10. + lines: + - amount: 0 + links: + - type: Invoice + id: INV-10 + amount: -0.05 + currencyRate: 1 + - type: CreditNote + id: TX-8 + amount: 0.05 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + - id: 03a5fdc8baa643fb97587033b0c4590b + customerRef: + id: 3cc3148bbd8111e8bad90617b3da4b8a + companyName: John's Test Customer + accountRef: + id: 2572c8766afc11e8aaa5027d54329956 + name: Tide Current + totalAmount: 100 + currency: GBP + currencyRate: 1 + date: '2017-11-23T00:00:00' + note: Customer receipt using credit/debit card + lines: + - amount: 100 + links: + - type: Invoice + id: ede1e735bd8111e8bad90617b3da4b8a + amount: -100 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2019-01-17T14:14:55Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2321 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + - id: '6105' + customerRef: + id: '531' + companyName: Shoprite + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '6' + name: Cash + totalAmount: 150 + currency: GBP + date: '2022-04-19T00:00:00' + note: '' + lines: + - amount: 150 + links: + - type: PaymentOnAccount + id: '531' + amount: -150 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2022-04-19T13:38:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments + Xero: + value: + results: + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + - id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 500 + links: + - type: Invoice + id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + amount: -500 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:51:43' + reference: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + - id: '104957000000067014' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-14T00:00:00' + note: '' + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038106' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '1' + pageNumber: 1 + pageSize: 2 + totalResults: 33 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-payments + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/paymentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + Clear Books: + value: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + Exact (UK): + value: + id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + FreeAgent: + value: + id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + KashFlow: + value: + id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + Oracle NetSuite: + value: + id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + QuickBooks Desktop: + value: + id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + QuickBooks Online Sandbox: + value: + id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + Sage 50 (UK): + value: + id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + Sage Intacct: + value: + id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + Xero: + value: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get payment + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-payment + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List suppliers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSuppliers' + examples: + Clear Books: + value: + results: + - id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: FyUkHbZxhn + supplierName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + phone: 0116 796 3163 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '0177-04-27T11:56:00' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 100 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: be49ec62-6754-ed11-946f-0022481b67d1 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2022-10-25T13:17:36Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 31 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + - id: 00014c12-2616-481a-a2e8-31bdf2497775 + supplierName: Ann's test supplier 2 + contactName: Ann's contact name + emailAddress: anna@anna888888.com + phone: '55555555' + addresses: + - type: Billing + line1: line1 + line2: line2 + city: city + region: region + country: RU + postalCode: postal + registrationNumber: '55566677788899944455' + taxNumber: RU4444444 + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-09T12:04:08Z' + defaultCurrency: USD + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + - id: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2020-05-01T14:05:46Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 118 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + - id: '9677150' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-24T06:19:23' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + - id: DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA== + 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' + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + - id: '9338173' + supplierName: Home + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '1990-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + - id: '726' + supplierName: Vendor -.A + contactName: Vendor -.A + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2021-03-26T09:53:15' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: A40000-1197774038 + supplierName: Bank of Anycity + contactName: Lisa D. Holzhauser + emailAddress: lisah@samplename.com + phone: 415-555-9135 + addresses: + - type: Billing + line1: 'Bank of Anycity, Lisa Holzhauser' + line2: 1935 Main Street + city: Middlefield + region: CA + postalCode: '94482' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 54 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + - id: '42' + supplierName: AI Support 2 + contactName: AI Support 2 + addresses: + - type: Billing + line1: test + region: string + country: DJ + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2021-08-31T08:45:02Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 23 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: '88' + supplierName: Andrew Haberbosch + addresses: [] + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2022-07-06T15:55:28Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + - id: '914' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + pageNumber: 1 + pageSize: 2 + totalResults: 943 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: MCN001 + supplierName: McNally Computer Supplies + contactName: Stuart Lynn + emailAddress: newbusinessadvice@sage.com + phone: 0191 415 3434 + addresses: + - type: Delivery + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + - type: Unknown + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + taxNumber: GB455 2385 34 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-12-05T13:37:26Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + - id: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + contactName: Abdi + emailAddress: abdisupplier@company.com + addresses: + - type: Billing + line1: 1 Place House + city: London + country: United Kingdom (GB) + postalCode: WC1X 1AH + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-13T10:38:19Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + - id: '29' + supplierName: Advisor Printing + contactName: 'Roach, Nathan' + phone: 130-202-4796 + addresses: + - type: Unknown + line1: 5 Carey Hill + line2: '' + city: Drayton Valley + region: Alberta + country: Canada + postalCode: G8V + registrationNumber: '' + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2022-06-15T11:38:29' + defaultCurrency: CAD + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx + supplierName: Flour Mill + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:12:40Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + supplierName: 7-Eleven + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + - id: '104957000000648001' + supplierName: Cool company + contactName: Dre + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-10T09:07:16' + defaultCurrency: CAD + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-suppliers + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/data/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + summary: Get supplier + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Clear Books: + value: + id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + Exact (UK): + value: + id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + FreeAgent: + value: + id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + FreshBooks: + value: + id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + Oracle NetSuite: + value: + id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + QuickBooks Desktop: + value: + id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + QuickBooks Online Sandbox: + value: + id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + Sage 50 (UK): + value: + id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + Sage Intacct: + value: + id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get supplier* endpoint returns a single supplier for a given supplierId. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-supplier + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List supplier attachments + description: | + The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: list-accounting-supplier-attachments + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get supplier attachment + description: | + The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: get-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download supplier attachment + description: | + The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: download-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List transfers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfers' + examples: + Clear Books: + value: + results: + - id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + - id: 78373000-29e1-4ef4-a2e6-9b573ed656e4 + description: depositing 188.33 into Current Account + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 357 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + - id: TST-001 + date: '2022-10-25T00:00:00' + from: + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + dataType: bankAccounts + currency: USD + amount: 3.6 + status: Unknown + to: + accountRef: + id: 8982e7d8-cb19-eb11-bbf9-0022481ad2f4 + dataType: bankAccounts + currency: GBP + amount: 2.34 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2022-10-25T15:47:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + - id: '308682395' + description: Transfer from Business Current Account to Nic Test11 + date: '2019-12-23T00:00:00' + from: + accountRef: + id: '469976' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + to: + accountRef: + id: '691393' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-31T16:09:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 99 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + - id: 2-11822 + contactRef: + id: '417' + dataType: customers + date: '2022-04-28T00:00:00' + from: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + to: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '7526' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T14:14:33' + pageNumber: 1 + pageSize: 2 + totalResults: 47 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + - id: C2A-933780606 + description: Funds Transfer + date: '2024-11-25T00:00:00' + from: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + to: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:04:07' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + - id: '678' + date: '2020-08-22T00:00:00' + from: + accountRef: + id: '124' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + to: + accountRef: + id: '109' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-29T00:01:20Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 442 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + - id: '1885' + date: '2020-09-02T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:23:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + - id: 73d909a4215a11e8b45c025132dab352 + description: Some cash + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:21:40Z' + pageNumber: 1 + pageSize: 2 + totalResults: 646 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + - id: '18828' + description: From bank account '700_CHK' to bank account 'Test Savings Account' + date: '2022-10-05T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 4040.62 + status: Unknown + to: + accountRef: + id: 'SAVINGSACCOUNT:17' + dataType: bankAccounts + currency: GBP + amount: 200 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-10-05T15:28:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-transfers + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transferId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transfer. + get: + tags: + - Transactions + summary: Get transfer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + Clear Books: + value: + id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + QuickBooks Desktop: + value: + id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + Sage Business Cloud Accounting: + value: + id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + Sage Intacct: + value: + id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transfer* endpoint returns a single transfer for a given transferId. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-transfer + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank accounts + operationId: list-accounting-bank-accounts + x-speakeasy-group: accounting-bank-data.accounts + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccounts' + examples: + Dynamics 365 Business Central: + value: + results: + - id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + - id: 47020f80-60e6-ec11-82f8-0022481a77f0 + accountName: '555' + accountType: Unknown + nominalCode: '40300' + sortCode: '' + accountNumber: '' + iBan: '' + currency: PLN + balance: 661.79 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 28 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + - id: '738778' + accountName: 2e2bna45hy\ + accountType: Debit + sortCode: '236972' + accountNumber: D01825250 + currency: GBP + balance: -114.4 + availableBalance: -114.4 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '765766' + accountName: 1a1a + accountType: Unknown + nominalCode: '70600' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 56 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + - id: '826' + accountName: Codat Europe Bank USD + accountType: Debit + nominalCode: '1133221133' + currency: USD + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2021-03-26T10:31:40' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + - id: 550001-1071509830 + accountName: Petty Cash + accountType: Unknown + nominalCode: '10400' + currency: GBP + balance: 500 + availableBalance: 500 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + - id: '163' + accountName: '11' + accountType: Debit + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + - id: '193' + accountName: 1 year ago + accountType: Debit + currency: GBP + balance: 5300.02 + availableBalance: 5300.02 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2023-01-18T06:05:12Z' + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + - id: '1210' + accountName: Bank Deposit Account + accountType: Unknown + nominalCode: '1210' + sortCode: 45-45-45 + accountNumber: 9/00474345 + iBan: '' + currency: GBP + balance: 3510 + availableBalance: 3510 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 0 + institution: Halifax Building Society + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + - id: 565ce07212bc492c8c2d04f43f9f67e3 + accountName: Abdi Live Test + accountType: Unknown + nominalCode: '147852' + sortCode: '123456' + accountNumber: '1234567' + currency: GBP + balance: -225830.75 + availableBalance: -225830.75 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + - id: 'CREDITCARD:58' + accountName: Cot Credit Card 2 + accountType: Credit + nominalCode: '11112' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:15:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + accountName: Business Savings Account + accountType: Debit + sortCode: '890303' + accountNumber: '876543210' + currency: GBP + balance: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:36:06' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts + Zoho Books: + value: + results: + - id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + - id: '104957000000065002' + accountName: Abdi Test 2 + accountType: Unknown + sortCode: '' + accountNumber: '' + currency: AED + balance: 98.03 + modifiedDate: '2022-10-03T08:40:38Z' + institution: '' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection. + + [Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + x-internal: true + tags: + - Accounting bank data + summary: Get bank account + operationId: get-accounting-bank-account + x-speakeasy-group: accounting-bank-data.accounts + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: + Dynamics 365 Business Central: + value: + id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + FreeAgent: + value: + id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + QuickBooks Desktop: + value: + id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + Oracle NetSuite: + value: + id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + Sage Intacct: + value: + id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bank account* endpoint returns a single account for a given accountId. + + [Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions': + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank account transactions + description: | + The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: list-accounting-bank-account-transactions + x-speakeasy-name-override: list-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankTransactions' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 07c891b4-f67a-ed11-9989-0022481ae525 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 1 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 5ced3895-f77a-ed11-9989-0022481b6241 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 2 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: cd12966b-8871-ed11-8c34-6045bd0c6935 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-12-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -17 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: b13392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -30 + balance: -72 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b3696a16-1fa2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -10 + balance: -122 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b73392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child + reconciled: false + amount: -40 + balance: -112 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: befdd569-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -13 + balance: -160 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: cb71c33a-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -25 + balance: -147 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: e7ec12c9-94a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -10 + balance: -27 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: fef7a026-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -15 + balance: -42 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 20869cb1-39a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: Accounts Payable + reconciled: false + amount: -14 + balance: -184 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 8c298754-20a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -170 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935d5578-3ca2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -201 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935f4303-e3a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -239 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: d8ceb342-dba2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -21 + balance: -222 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: 15719c0c-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -292.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 213d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -9.35 + balance: -265.19 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 273d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: -7.5 + balance: -272.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978c4a27-e0a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 2.16 + balance: -236.84 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: a80f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -7.01 + balance: -262.85 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ad0f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: 7.01 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b5de7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -4.91 + balance: -260.75 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: bbde7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 4.91 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f9540bf4-e5a2-ed11-9a88-000d3ad5d945 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: feca50d8-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-06T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -312.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 4777d7ec-cfa6-ed11-9a88-000d3a7fb2e5 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-07T00:00:00' + description: '' + reconciled: false + amount: -2.34 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 38b632de-7aac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: Invalid VAT Posting Setup + reconciled: false + amount: -10 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ffc0b740-68a8-ed11-9a88-6045bdd12fc1 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: '' + reconciled: false + amount: 10 + balance: -305.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 95f27455-7cac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-14T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -325.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 0d6b1378-acae-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-16T00:00:00' + description: Bank Account Line + reconciled: false + amount: -12 + balance: -337.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978da9f7-baae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: 6 + balance: -342.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: dd34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: G/L + reconciled: false + amount: -1 + balance: -338.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Customer + reconciled: false + amount: 2 + balance: -336.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e734e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Vendor + reconciled: false + amount: -3 + balance: -339.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ed34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: -4 + balance: -343.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Employee + reconciled: false + amount: -5 + balance: -348.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 39de1293-d3b1-ed11-9a88-6045bd0f94d6 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-21T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -352.03 + transactionType: Credit + modifiedDate: '2023-03-27T14:21:19Z' + pageNumber: 1 + pageSize: 100 + totalResults: 37 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + FreeAgent: + value: + results: + - id: '261197890' + accountId: '738783' + clearedOnDate: '2020-10-28T00:00:00' + description: Invoice receipt against 1762 + reconciled: true + amount: 111 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2020-10-28T16:27:10Z' + - id: '290878530' + accountId: '738783' + clearedOnDate: '2021-04-23T00:00:00' + description: Invoice receipt against 1980 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:42Z' + - id: '290825614' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1976 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-26T14:05:15Z' + - id: '290878531' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1981 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:44Z' + - id: '291227300' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2002 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T13:43:56Z' + - id: '291242296' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2012 + reconciled: true + amount: 40 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T16:14:16Z' + - id: '346437532' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T14:59:40Z' + - id: '346444438' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:37:54Z' + - id: '346444989' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:41:22Z' + - id: '346457774' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Credit Note refund against 2313 + reconciled: true + amount: -1 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:07:50Z' + - id: '346458196' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2311 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:14:15Z' + - id: '414441841' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'MCDONALDS - ROYSTON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -12.78 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441842' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -7.98 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441845' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -648.63 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441847' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -324.31 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441849' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'RUGBY, PRET A MANGER - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441851' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'Just Eat - London - Card Ending: 9271//OTHER/' + reconciled: false + amount: -22.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441852' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'CN TAR TAROM SA-MOBILP - ORAS OTOPENI - Card Ending: 4999//OTHER/' + reconciled: false + amount: -340.13 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441854' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'MOTO RUGBY SERVICES - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -126.12 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441855' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'POMANDA.COM - 138 HOLBORN, - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441856' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'RYANAIR 224BEZ3YM - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -267.97 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441857' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441859' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'SPOTIFY - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -16.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441860' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'Revive My Device - London - Card Ending: 5913//OTHER/' + reconciled: false + amount: -149 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441861' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -39.36 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441862' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.4 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441863' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'Amazon.co.uk*1N0N04VK4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.76 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441864' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441865' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -16.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441866' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -4.55 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441867' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TRAVELODGE GB0937 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441868' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -34.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441869' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441870' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SIDS DIY - LONDON E1 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -5.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441871' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'RESOLUTION GB LTD - WHITCHURCH - Card Ending: 2327//OTHER/' + reconciled: false + amount: -368.72 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441872' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441874' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -5.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441875' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 6.8 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441876' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 12.49 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441877' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441878' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -27.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441879' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441880' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -25.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441881' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'CREAMLINE DAIRIES ONLINE - MANCHESTER - Card Ending: 2327//OTHER/' + reconciled: false + amount: -50 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441883' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'AIRBNB * HMYDEXRY4N - 203-318-1111 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -388.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441884' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441886' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441889' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.84 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441891' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'WELCOME BREAK - NEWPORT PAGNE - Card Ending: 9271//OTHER/' + reconciled: false + amount: -102.23 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441892' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'SUBWAY 63582 London Gatew - Mill Hill, Lo - Card Ending: 9271//OTHER/' + reconciled: false + amount: -15.38 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441893' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -40.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441894' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441895' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -34.06 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441897' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441901' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Tesla - West Drayton - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441904' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Box Deansgate - Manchester - Card Ending: 0614//OTHER/' + reconciled: false + amount: -20.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441906' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'MANCHESTER UNITED KIOSK - MANCHESTER - Card Ending: 0614//OTHER/' + reconciled: false + amount: -26.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441908' + accountId: '738783' + clearedOnDate: '2022-12-29T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441909' + accountId: '738783' + clearedOnDate: '2022-12-31T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -1.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441910' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441911' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -11.95 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441912' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -13.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441913' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441914' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.14 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441915' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'GOOGLE*GSUITE ISOMI.CO - DUBLIN 2 - Card Ending: 1332//OTHER/' + reconciled: false + amount: -216.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441916' + accountId: '738783' + clearedOnDate: '2023-01-03T00:00:00' + description: 'Refund: AMZ*quickpickdeals - amazon.co.uk - Card Ending: 4999//OTHER/' + reconciled: false + amount: 10.97 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441917' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: Finance Charge//OTHER/ + reconciled: false + amount: -0.41 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441918' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441919' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -86.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441920' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441922' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'AMAZON PRIME*164AU3UZ4 AM - AMZN.CO.UK/PM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -96 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441924' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162DC7II4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -44.62 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441926' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'trainline - +443332022222 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -65.46 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441931' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'VITAL PARTS LTD - MAIDSTONE - Card Ending: 2327//OTHER/' + reconciled: false + amount: -124.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441934' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*168E49IU4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441935' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -108.16 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441936' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Refund: ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: 22.96 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441937' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H31B0CO4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -20.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441939' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H4GR4CH4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -13.69 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441941' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162V47WY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -16.83 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441945' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*160J00WI4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441946' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*1692Y9YY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441947' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*166I62Y14 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441948' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'GMELIUS GROWTH - MEYRIN - Card Ending: 5913//OTHER/' + reconciled: false + amount: -121.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441949' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -116.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441950' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -66.79 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441951' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'TOOLSTATION UK - NORTHAMPTON - Card Ending: 2327//OTHER/' + reconciled: false + amount: -77.88 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441952' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'SHELL CHESTER - CHESTER - Card Ending: 9271//OTHER/' + reconciled: false + amount: -112.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441953' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1252150515112 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -450.85 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441954' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1254217966962 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441955' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441956' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'Amazon.co.uk*1H97Y6TL4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441957' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -15.03 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441959' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -16.43 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441960' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: Payment made (BACS)//OTHER/ + reconciled: false + amount: 5000 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441961' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -32.57 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441962' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TESCO STORES - LONDON - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441963' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'VICTORIA INN - PECKHAM - Card Ending: 5913//OTHER/' + reconciled: false + amount: -15.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441965' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -7.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441967' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'PRET A MANGER - 326 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -13.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + pageNumber: 1 + pageSize: 100 + totalResults: 153 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions?page=2&pageSize=100 + KashFlow: + value: + results: + - id: '765768:137014109' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: FIRST Transaction + reconciled: false + amount: 100 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:137014143' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: SECOND Transaction + reconciled: false + amount: 120 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:93269803' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: 'KF00021:' + reconciled: false + amount: -5 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:141203309' + accountId: '765768' + clearedOnDate: '2020-06-18T00:00:00' + description: 'INV #33: Customer overpayment' + reconciled: false + amount: 110 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:144653342' + accountId: '765768' + clearedOnDate: '2020-10-23T00:00:00' + description: '' + reconciled: false + amount: 1 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 100 + totalResults: 5 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + accountId: 20000-933270541 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + reconciled: false + amount: -1200 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:10' + - id: DFA-933785132 + accountId: 20000-933270541 + clearedOnDate: '2022-12-05T00:00:00' + description: '' + reconciled: false + amount: -35 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: E2E-933785785 + accountId: 20000-933270541 + clearedOnDate: '2022-12-10T00:00:00' + description: '' + reconciled: false + amount: -197.59 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: 536B-1197755199 + accountId: 20000-933270541 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + reconciled: false + amount: -2100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:47' + - id: 5C18-1197711471-to + accountId: 20000-933270541 + clearedOnDate: '2022-12-31T00:00:00' + description: Opening Balance - Bank Balance - Checking Account + reconciled: false + amount: 27874.62 + transactionType: Other + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:06' + - id: 3A09-1071529982 + accountId: 20000-933270541 + clearedOnDate: '2023-01-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 95C6-1197729008 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: 941 Deposit for December 2005 Payyroll + reconciled: false + amount: -3495.82 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95CA-1197729081 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: FUTA Payment - 4 Qrt 2005 + reconciled: false + amount: -100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D0-1197729222 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: State Unemployment and Disability - 4th Quarter 2005 + reconciled: false + amount: -208.09 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D4-1197729376 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Worker's Compensation - 4th Quarter 2005 + reconciled: false + amount: -1214.31 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 9C06-1181931827 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Deposit + reconciled: false + amount: 1228.18 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E3A-1182063799 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -308.34 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: A293-1197953458 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -12362.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AB-1197953786 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -9521 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A33E-1197955762 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -3146.88 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 6992-1197775718 + accountId: 20000-933270541 + clearedOnDate: '2023-01-17T00:00:00' + description: Deposit + reconciled: false + amount: 15281.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3E5D-1071498699 + accountId: 20000-933270541 + clearedOnDate: '2023-01-21T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: 699D-1197775731 + accountId: 20000-933270541 + clearedOnDate: '2023-01-25T00:00:00' + description: Deposit + reconciled: false + amount: 31474.25 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 53D-933354764 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:00' + - id: 9E3D-1182131998 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -205 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E42-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -532 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E47-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -623 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E4C-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -13759 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED6-1182133365 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Fuel + reconciled: false + amount: -138 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F2D-1197948760 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Vehicle Repairs and Maintenance + reconciled: false + amount: -218 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F96-1197949640 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -123.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: A2CD-1197955250 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Pmt# 1 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: F29-933787474 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:13' + - id: 698D-1197775698 + accountId: 20000-933270541 + clearedOnDate: '2023-02-02T00:00:00' + description: Deposit + reconciled: false + amount: 1040 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 69A8-1197775740 + accountId: 20000-933270541 + clearedOnDate: '2023-02-09T00:00:00' + description: Deposit + reconciled: false + amount: 271.53 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3A10-1071529997 + accountId: 20000-933270541 + clearedOnDate: '2023-02-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: A0BD-1197950967 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -268.39 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AF-1197953842 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -4050.98 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A343-1197955826 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -1466.32 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C0B-1181931843 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Deposit + reconciled: false + amount: 25471.56 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E63-1182132109 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: For Vetter Basement Remodel + reconciled: false + amount: -2050 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED9-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Fuel + reconciled: false + amount: -142 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F33-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -222 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F99-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -125.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FBD-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A052-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A081-1197950831 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D1-1197955271 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Pmt# 2 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A17-1071530007 + accountId: 20000-933270541 + clearedOnDate: '2023-03-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 9C38-1182054225 + accountId: 20000-933270541 + clearedOnDate: '2023-03-13T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: A296-1197953484 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: '' + reconciled: false + amount: -1600 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A346-1197955854 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -83.6 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C10-1181931855 + accountId: 20000-933270541 + clearedOnDate: '2023-03-20T00:00:00' + description: Deposit + reconciled: false + amount: 6278.8 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E72-1182132247 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: '' + reconciled: false + amount: -435 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9EDC-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Fuel + reconciled: false + amount: -127 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F36-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7B-1197949443 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9C-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -389.2 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC0-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A056-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A084-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D5-1197955280 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Pmt# 3 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A1E-1071530019 + accountId: 20000-933270541 + clearedOnDate: '2023-04-12T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 4271-1071523732 + accountId: 20000-933270541 + clearedOnDate: '2023-04-17T00:00:00' + description: '' + reconciled: false + amount: -714 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:32' + - id: 3E98-1071499056 + accountId: 20000-933270541 + clearedOnDate: '2023-04-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:11' + - id: 9C68-1182054440 + accountId: 20000-933270541 + clearedOnDate: '2023-04-20T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 9EDF-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Fuel + reconciled: false + amount: -162 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F39-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -192 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9F-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -120.93 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC3-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05A-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A087-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D9-1197955286 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Pmt# 4 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C86-1182054823 + accountId: 20000-933270541 + clearedOnDate: '2023-05-01T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 3A25-1071530029 + accountId: 20000-933270541 + clearedOnDate: '2023-05-13T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: A0C0-1197950991 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -950.23 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A299-1197953515 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -1400 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A349-1197955899 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -318.02 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CB8-1182055085 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 9EE2-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Fuel + reconciled: false + amount: -143 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3C-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA2-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC6-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05E-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08A-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2DD-1197955294 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Pmt# 5 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CBD-1182055262 + accountId: 20000-933270541 + clearedOnDate: '2023-06-06T00:00:00' + description: '' + reconciled: false + amount: -5275 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 3A2C-1071530042 + accountId: 20000-933270541 + clearedOnDate: '2023-06-10T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 5356-1197761596 + accountId: 20000-933270541 + clearedOnDate: '2023-06-16T00:00:00' + description: '' + reconciled: false + amount: -1786 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:46' + - id: 9EE5-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Fuel + reconciled: false + amount: -157 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3F-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -186 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7E-1197949458 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA5-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -135.02 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC9-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A062-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08D-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2E1-1197955306 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Pmt# 6 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A33-1071530066 + accountId: 20000-933270541 + clearedOnDate: '2023-07-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 3E67-1071498733 + accountId: 20000-933270541 + clearedOnDate: '2023-07-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: A0C3-1197951027 + accountId: 20000-933270541 + clearedOnDate: '2023-07-23T00:00:00' + description: '' + reconciled: false + amount: -239.29 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: 9EE8-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Fuel + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F42-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA8-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FCC-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A066-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + pageNumber: 1 + pageSize: 100 + totalResults: 495 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions?page=2&pageSize=100 + Sage 50 (UK): + value: + results: + - id: '73' + accountId: '1200' + clearedOnDate: '2021-01-29T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -10164.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '52' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '568953' + reconciled: false + amount: -1497.58 + balance: -10302.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '53' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '5897532' + reconciled: false + amount: 500 + balance: -9802.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '54' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: TRANS + reconciled: false + amount: -250 + balance: -10052.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '58' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -10002.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '50' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -8804.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '85' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: '6565689' + reconciled: false + amount: -1800 + balance: -11964.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '97' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -17896.83 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1183' + accountId: '1200' + clearedOnDate: '2021-09-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 11299.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1184' + accountId: '1200' + clearedOnDate: '2021-09-15T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 10099.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1185' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 9949.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1186' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 9944.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1187' + accountId: '1200' + clearedOnDate: '2021-10-13T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 8744.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1188' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 8594.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1189' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 8588.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1190' + accountId: '1200' + clearedOnDate: '2021-11-10T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 7388.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1191' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 7238.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1192' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 7233.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1193' + accountId: '1200' + clearedOnDate: '2021-12-08T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 6033.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1194' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 5883.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1195' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 5877.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '24' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: O/Bal + reconciled: true + amount: -6511.96 + balance: -6511.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '26' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '56956' + reconciled: false + amount: 55 + balance: -6456.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '27' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656678' + reconciled: false + amount: -150 + balance: -6606.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '28' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656679' + reconciled: false + amount: -352 + balance: -6958.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '29' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656680' + reconciled: false + amount: -550 + balance: -7508.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '30' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656681' + reconciled: false + amount: -250 + balance: -7758.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '31' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656869' + reconciled: false + amount: -546 + balance: -8304.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1196' + accountId: '1200' + clearedOnDate: '2022-01-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 5715.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1197' + accountId: '1200' + clearedOnDate: '2022-01-05T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 4515.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1198' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 4365.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1199' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 4360.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '255' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: (BACS) + reconciled: false + amount: -370.71 + balance: -18267.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '256' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100001' + reconciled: false + amount: -256.36 + balance: -18523.9 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '257' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100002' + reconciled: false + amount: -25.5 + balance: -18549.4 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '258' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100003' + reconciled: false + amount: -1977.58 + balance: -20526.98 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '259' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100004' + reconciled: false + amount: -599.03 + balance: -21126.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '260' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100005' + reconciled: false + amount: -7141.98 + balance: -28267.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '261' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100006' + reconciled: false + amount: -150.96 + balance: -28418.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '262' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100007' + reconciled: false + amount: -63 + balance: -28481.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '263' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100008' + reconciled: false + amount: -35.01 + balance: -28516.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '264' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100009' + reconciled: false + amount: -1659.34 + balance: -30176.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '265' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '4353454' + reconciled: false + amount: 1432.17 + balance: -28744.13 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '266' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 2684.26 + balance: -26059.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '267' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1204.57 + balance: -24855.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '268' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1140.78 + balance: -23714.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '269' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 4372 + balance: -19342.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '270' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1946.18 + balance: -17396.34 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '271' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 11123.33 + balance: -6273.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1200' + accountId: '1200' + clearedOnDate: '2022-02-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 3160.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '300' + accountId: '1200' + clearedOnDate: '2022-02-03T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -16588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1201' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 3010.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1202' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 3004.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '276' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Credit + reconciled: false + amount: -500 + balance: -6773.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '279' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: -58.75 + balance: -6831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '280' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -1400 + balance: -8231.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '282' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -12600 + balance: -20831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '286' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: 6500 + balance: -14331.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '287' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: PAYE + reconciled: false + amount: -1256.33 + balance: -15588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '288' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Deposit + reconciled: false + amount: -500 + balance: -16088.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '314' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -16750.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '315' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -17950.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '325' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -150 + balance: -18100.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '326' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -5.55 + balance: -18105.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '328' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Returned + reconciled: false + amount: 103.4 + balance: -18002.24 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '331' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -23934.53 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '523' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 6556.33 + balance: -17378.2 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '525' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 3350.33 + balance: -14027.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '526' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: (BACS) + reconciled: false + amount: -435.14 + balance: -14463.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '529' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '12324' + reconciled: false + amount: -8561.48 + balance: -23024.49 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '532' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: VOID + reconciled: false + amount: 352.5 + balance: -22671.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '534' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: SED + reconciled: false + amount: 55 + balance: -22616.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1203' + accountId: '1200' + clearedOnDate: '2022-03-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 1804.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '821' + accountId: '1200' + clearedOnDate: '2022-03-10T00:00:00' + description: '' + reconciled: false + amount: 1908.89 + balance: -14370.08 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '820' + accountId: '1200' + clearedOnDate: '2022-03-20T00:00:00' + description: '776' + reconciled: false + amount: 9057.34 + balance: -16278.97 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '606' + accountId: '1200' + clearedOnDate: '2022-03-24T00:00:00' + description: Deposit + reconciled: false + amount: -150 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '607' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '44555' + reconciled: false + amount: 100 + balance: -22270.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '823' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '' + reconciled: false + amount: 1770.15 + balance: -12229.5 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '578' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '456' + reconciled: false + amount: -15 + balance: -22084.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '608' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: CREDIT + reconciled: false + amount: -100 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '824' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '' + reconciled: false + amount: 1025.86 + balance: -11203.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1204' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 1654.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1205' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 1649.06 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '546' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -22778.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '547' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -23978.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '548' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: -24128.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '549' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: -24134.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '555' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -24084.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '560' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 64.63 + balance: -24019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '562' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 2000 + balance: -22019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '563' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: -50 + balance: -22069.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '584' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: CREDIT + reconciled: false + amount: -70.31 + balance: -22155.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '589' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 30 + balance: -22125.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '596' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 35.01 + balance: -22090.21 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '597' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: PAYE + reconciled: false + amount: -2070.23 + balance: -24160.44 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '598' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -25163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '604' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 3000 + balance: -22163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '605' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: '225' + reconciled: false + amount: -56.16 + balance: -22220.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '612' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -29305.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '614' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: Sales + reconciled: false + amount: 179.2 + balance: -29126.67 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + pageNumber: 1 + pageSize: 100 + totalResults: 179 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions?page=2&pageSize=100 + Sage Business Cloud Accounting: + value: + results: + - id: 26b727ca84734e3c8e245011bd04dbf1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -5 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T11:35:39Z' + - id: 508f3fd4403e45cb903b362a4ae55344 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-10T10:51:43Z' + - id: 52e58431005e44328af44116e0433230 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.85 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:36:01Z' + - id: f3255e4b79c5427ba5b963d0e26cecfc + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:19:24Z' + - id: a00e1ce357cc4064b9cce8abe1b15110 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-04-21T00:00:00' + description: Cash Deposit Bank Transfer + reconciled: false + amount: 1000 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-04-21T21:03:25Z' + - id: a7d26740129945c3a76209020fbb7fd1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-11-25T00:00:00' + description: Bank Transfer + reconciled: false + amount: -40 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-11-25T19:35:03Z' + - id: 829f45112347471cbf99b0d9afe08113 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-02T00:00:00' + description: Made from codat api Customer Receipt + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-02T13:14:57Z' + - id: 786f769ae88a4fa898e25e2cbff43be3 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-20T00:00:00' + description: Supplier payment AD Supplier Payment + reconciled: false + amount: -2400 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-22T14:12:38Z' + - id: abb5995867c546c2b32097d515dcef2a + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-21T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 12 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-21T14:09:59Z' + - id: 943f3bd6eacc4071807d89895fe03ef4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-08-17T00:00:00' + description: Ref5565 Other Receipt + reconciled: false + amount: 50 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-08-17T11:58:37Z' + - id: 039e6bb20b6e44d690601e4dd04a5b21 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-22T00:00:00' + description: Note 1 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-22T14:22:57Z' + - id: 1a62f54358e74ba4a71dd733f2b08ba4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-27T00:00:00' + description: Note 2 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-27T14:04:05Z' + - id: a79ebcf0710d415baad6b588eb28307b + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-12-01T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 33 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-12-01T13:03:00Z' + - id: 4b691b78b6cd43c9a64d75aeb29e4d11 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T08:51:52Z' + - id: 7b1f2f55f39042838d5f7226aa92386f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -1415 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:15:26Z' + - id: 87eca750292b4cfea216e13bb22923c6 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:01:47Z' + - id: a48474f83d214637a700e76e24446086 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:10:42Z' + - id: cc1fc960e05c40c1968314efe1175b9f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: string Customer Receipt + reconciled: false + amount: 69 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:20:09Z' + - id: e600eb7549b74d96bdca18b9cc60f39d + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: Customer Receipt + reconciled: false + amount: 60 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:12:03Z' + pageNumber: 1 + pageSize: 100 + totalResults: 19 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + Xero: + value: + results: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2021-12-20T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -3136.22 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5703.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: INV0010 + counterparty: MADDOX PUBLISHING GP + reconciled: true + amount: 4200 + balance: -6203.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -10403.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-19T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -95.5 + balance: -5798.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-19T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5298.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -97 + balance: -5395.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-19T00:00:00' + description: INV-0003 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -4895.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -92 + balance: -4987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: INV-0004 + counterparty: Ridgeway University + reconciled: true + amount: 1000 + balance: -3987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -89 + balance: -4076.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-19T00:00:00' + description: INV-005 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3576.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -91 + balance: -3667.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-20T00:00:00' + description: INV-006 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3167.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-22T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -96.25 + balance: -3264.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-19T00:00:00' + description: INV-007 + counterparty: Ridgeway University + reconciled: true + amount: 1500 + balance: -1764.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -100.6 + balance: -1864.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-19T00:00:00' + description: INV-008 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -1364.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -105.75 + balance: -1470.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-19T00:00:00' + description: INV-009 + counterparty: Ridgeway University + reconciled: true + amount: 1200 + balance: -270.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -106.5 + balance: -377.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-20T00:00:00' + description: INV-0010 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: 122.98 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -119.08 + balance: 3.9 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-22T00:00:00' + description: Monthly a/c fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: -11.1 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: FP089876 + counterparty: FastPay + reconciled: true + amount: -3126.17 + balance: -1591.58 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: Subs DD + counterparty: Xero + reconciled: true + amount: -56.35 + balance: -89.16 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '0015' + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 1534.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0014 + counterparty: Port & Philip Freight + reconciled: true + amount: 541.25 + balance: 993.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '' + counterparty: Office Supplies Company + reconciled: true + amount: -21.71 + balance: -32.81 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0013 + counterparty: Young Brothers + reconciled: true + amount: 541.25 + balance: 452.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-24T00:00:00' + description: INV0012 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: -1050.33 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + counterparty: Woolworths Oaktown + reconciled: true + amount: -65.2 + balance: -1115.53 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-02T00:00:00' + description: '' + counterparty: Berry Brew Cafe + reconciled: true + amount: -15.6 + balance: -1131.13 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-09T00:00:00' + description: AR-0019 + counterparty: Bank West + reconciled: true + amount: 1500 + balance: 368.87 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-11T00:00:00' + description: CHQ 6543-000409 + counterparty: Melrose Parking Services + reconciled: true + amount: -148.5 + balance: 220.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-16T00:00:00' + description: '' + counterparty: Espresso 31 Ltd + reconciled: true + amount: -16 + balance: 204.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-19T00:00:00' + description: '' + counterparty: Brunswick Flower Suppliers T/A Brunswick Petals + reconciled: true + amount: -50 + balance: 154.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: AR-0011 + counterparty: Ridgeway University + reconciled: true + amount: 2500 + balance: 2583.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + counterparty: Mobil + reconciled: true + amount: -70.8 + balance: 83.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: PC Complete + reconciled: true + amount: -1463.88 + balance: 1449.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: AR-0018 + counterparty: City Agency + reconciled: true + amount: 329.8 + balance: 2913.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: Bank Fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: 1434.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 253.24 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-29T00:00:00' + description: FP101897 + counterparty: FastPay + reconciled: false + amount: -1223.91 + balance: -970.67 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Net Connect + reconciled: true + amount: -98.32 + balance: -1177.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Power Direct + reconciled: true + amount: -108.6 + balance: -1079.27 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: AR-0020 + counterparty: Ridgeway University + reconciled: true + amount: 6187.5 + balance: 5009.91 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 3828.66 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Swantston Security + reconciled: true + amount: -59.54 + balance: 3769.12 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-21T00:00:00' + description: '' + counterparty: Xero + reconciled: true + amount: -56.35 + balance: 3712.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-22T00:00:00' + description: INV0022 + counterparty: Petrie McLoud + reconciled: true + amount: 1407.25 + balance: 5120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-23T00:00:00' + description: '0024' + counterparty: Boom FM + reconciled: true + amount: 1000 + balance: 6120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-24T00:00:00' + description: CHQ 6543-000410 + counterparty: Melrose Parking + reconciled: true + amount: -148.5 + balance: 5971.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-25T00:00:00' + description: 0027-Part + counterparty: DIISR + reconciled: true + amount: 579.37 + balance: 6550.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: Inv 0029 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: 7092.14 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV0032 + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 8715.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: '0030' + counterparty: Young Brothers Transport + reconciled: true + amount: 541.25 + balance: 7633.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV-0031 + counterparty: Port & Philip Freight Limited + reconciled: true + amount: 541.25 + balance: 8174.64 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-27T00:00:00' + description: Eft + counterparty: Woolworths Oaktown + reconciled: true + amount: -34.1 + balance: 8681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-28T00:00:00' + description: 033-Full + counterparty: DIISR + reconciled: true + amount: 250 + balance: 8931.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-30T00:00:00' + description: Eft + counterparty: Office Supplies Company + reconciled: true + amount: -49.2 + balance: 8882.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + counterparty: Berry Brew + reconciled: true + amount: -22 + balance: 8860.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-01T00:00:00' + description: CHQ 6543-000411 + counterparty: 24 Locks + reconciled: true + amount: -69.5 + balance: 8791.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-02T00:00:00' + description: 08-4123 + counterparty: Hoyt Productions Ltd + reconciled: true + amount: -5953.75 + balance: 2837.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-03T00:00:00' + description: '' + counterparty: Carlton Functions + reconciled: true + amount: -1500 + balance: 1337.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-06T00:00:00' + description: Exps + counterparty: O.Greenville + reconciled: true + amount: -29.5 + balance: 1307.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: Rent + counterparty: Truxton Property Management + reconciled: false + amount: -1181.25 + balance: 6314.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: INV-0035 + counterparty: Ridgeway University + reconciled: false + amount: 6187.5 + balance: 7495.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0017-Part + counterparty: City Limousines + reconciled: false + amount: 100 + balance: 1914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: DEPOSIT ADV + counterparty: Jakaranda Maple Systems + reconciled: false + amount: 2000 + balance: 3914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0195 0210 + counterparty: SMART Agency + reconciled: false + amount: -4500 + balance: 1814.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-09T00:00:00' + description: Eft + counterparty: Cooper Street Bakery + reconciled: false + amount: -15.75 + balance: 3898.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-10T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 3882.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Swanston Security + reconciled: false + amount: -59.55 + balance: 3811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Cooper Street Bakery + reconciled: false + amount: -11.9 + balance: 3870.94 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Whitcoulls + reconciled: false + amount: -29.8 + balance: 4769.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1000 + balance: 4811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4799.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4757.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Sub 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: -49.9 + balance: 4588.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Reg 8018922 + counterparty: ACL Conferences + reconciled: false + amount: -85 + balance: 4672.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: New World + reconciled: false + amount: -34.6 + balance: 4637.99 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: Sublet RM2031 + counterparty: Majestic Contracting + reconciled: false + amount: 450 + balance: 6526.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4576.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1500 + balance: 6076.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6499.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: CR 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: 35 + balance: 6534.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -14.3 + balance: 6511.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 200 + balance: 6712.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -10.5 + balance: 6512.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: Fee + counterparty: Ridgeway Banking Corporation + reconciled: false + amount: -15 + balance: 6697.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 6681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6522.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + pageNumber: 1 + pageSize: 100 + totalResults: 93 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + Zoho Books: + value: + results: + - id: 104957000000060010-104957000000070175 + accountId: '104957000000060010' + clearedOnDate: '2020-02-06T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000060014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-12T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Dep + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000067014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-14T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070035 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 11980 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070055 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070097 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 10789.21 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000097011 + accountId: '104957000000060010' + clearedOnDate: '2020-02-26T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099013 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: -72 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099053 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000137017 + accountId: '104957000000060010' + clearedOnDate: '2020-05-19T00:00:00' + description: '' + reconciled: false + amount: 9000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336002 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336020 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: 1.79 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001706009 + accountId: '104957000000060010' + clearedOnDate: '2021-04-12T00:00:00' + description: '' + reconciled: false + amount: 200 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001469026 + accountId: '104957000000060010' + clearedOnDate: '2022-05-12T00:00:00' + description: '' + reconciled: false + amount: -50 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480001 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: 18.98 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480045 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001633002 + accountId: '104957000000060010' + clearedOnDate: '2022-07-27T00:00:00' + description: '' + reconciled: false + amount: 26 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001652007 + accountId: '104957000000060010' + clearedOnDate: '2022-08-08T00:00:00' + description: '' + reconciled: false + amount: 11.75 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689069 + accountId: '104957000000060010' + clearedOnDate: '2022-08-24T00:00:00' + description: '' + reconciled: false + amount: -2.89 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689125 + accountId: '104957000000060010' + clearedOnDate: '2022-08-25T00:00:00' + description: '' + reconciled: false + amount: 3.6 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + pageNumber: 1 + pageSize: 100 + totalResults: 20 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedDebtor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + x-internal: true + tags: + - Accounts receivable + summary: Aged debtors report available + description: Indicates whether the aged debtors report is available for the company. + operationId: is-aged-debtors-report-available + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + x-speakeasy-name-override: is-aged-debtors-available + x-speakeasy-group: accounts-receivable.reports + '/companies/{companyId}/reports/agedDebtor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged debtors report + description: Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. + operationId: get-accounting-aged-debtors-report + x-speakeasy-name-override: get-aged-debtors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedDebtorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.4959955Z' + reportDate: '2023-05-02T16:05:21.4459444Z' + data: + - customerId: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3367.71 + details: + - name: CreditNotes + amount: -3367.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4299.26 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -4299.26 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 981d56a7-cf63-4ed2-b8db-2eba2c0aeb5a + customerName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14959.84 + details: + - name: CreditNotes + amount: -14959.84 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 773.94 + details: + - name: Invoices + amount: 773.94 + - customerId: d3739e0f-5a70-465b-9dfe-deb8efac0cd3 + customerName: Damien Schneider + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2817.59 + details: + - name: CreditNotes + amount: -2817.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 10652b76-2a9a-43ba-a892-fb4f369fe1ef + customerName: Franco Labadie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1541.52 + details: + - name: CreditNotes + amount: -1541.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 03b7f9fd-40e0-4c71-9f93-58e867233bcb + customerName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14312.59 + details: + - name: CreditNotes + amount: -14312.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 158.76 + details: + - name: Invoices + amount: 158.76 + - customerId: bbea9634-7a60-4c3f-97cd-70e481ec2cce + customerName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -32818.36 + details: + - name: CreditNotes + amount: -32818.36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 431.71 + details: + - name: Invoices + amount: 431.71 + - customerId: d65ac505-072c-49ec-be3c-3cb74228966d + customerName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9766.18 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -9766.18 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1273.16 + details: + - name: Invoices + amount: 1273.16 + - customerId: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + customerName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2595.66 + details: + - name: CreditNotes + amount: -2595.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1397.98 + details: + - name: Invoices + amount: 1397.98 + - customerId: f67eab14-12f1-432f-af73-81ebf6ec8ddc + customerName: Neoma Kreiger + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3047.62 + details: + - name: CreditNotes + amount: -3047.62 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 2d6a5c2d-80dc-4aac-8909-ddfb3cb24437 + customerName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -225.44 + details: + - name: CreditNotes + amount: -225.44 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 976a2402-0908-46d9-9121-a93005d29c01 + customerName: Norbert Tillman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -537.61 + details: + - name: CreditNotes + amount: -537.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 453ddfc0-49ce-4f66-a815-dae734be885c + customerName: Ralph Wilderman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2538.49 + details: + - name: CreditNotes + amount: -2538.49 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 51f03576-f6b0-40d5-9fba-81a490411c03 + customerName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4403.5 + details: + - name: CreditNotes + amount: -4403.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3477.81 + details: + - name: Invoices + amount: 3477.81 + - customerId: 84539fde-118f-48ed-978d-0aa50c7ec223 + customerName: Rodger Feest + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1456.66 + details: + - name: CreditNotes + amount: -1456.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7366.21 + details: + - name: Invoices + amount: 7366.21 + - customerId: dc75136b-b504-49c5-be35-04e1d2771e1e + customerName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80.97 + details: + - name: CreditNotes + amount: -80.97 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:20.8918448Z' + reportDate: '2023-05-02T16:05:20.8411594Z' + data: + - customerId: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + customerName: Abdi Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80 + details: + - name: CreditNotes + amount: -80 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -257.28 + details: + - name: Payments + amount: -300 + - name: Invoices + amount: 42.72 + - customerId: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Adatum Corporation + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1558.56 + details: + - name: CreditNotes + amount: -1558.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33200.76 + details: + - name: Invoices + amount: 34782.32 + - name: Payments + amount: -1581.56 + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8554.46 + details: + - name: Invoices + amount: 8554.46 + - customerId: ba1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Alpine Ski House + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7503.08 + details: + - name: Invoices + amount: 7503.08 + - customerId: f5860a8e-4b5a-eb11-89fa-00224800af18 + customerName: CustomerQA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 349.68 + details: + - name: Invoices + amount: 349.68 + - customerId: feef29a2-1d59-ed11-8c36-002248c5e6c0 + customerName: DP Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 332.2 + details: + - name: Invoices + amount: 427.2 + - name: Payments + amount: -95 + - customerId: 264d74d4-3218-ed11-90eb-000d3a873415 + customerName: Eliana + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -779.28 + details: + - name: CreditNotes + amount: -779.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1905 + details: + - name: Invoices + amount: 1905 + - customerId: 99faf6fb-5209-eb11-bbf6-0022481ad2e8 + customerName: QA Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4923.48 + details: + - name: Invoices + amount: 4923.48 + - customerId: bc1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Relecloud + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10559.04 + details: + - name: Invoices + amount: 10559.04 + - customerId: b81217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: School of Fine Art + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33438.88 + details: + - name: Invoices + amount: 34811.2 + - name: Payments + amount: -1372.32 + - customerId: dc3f4f1b-3c54-ed11-9470-002248c5e18c + customerName: Test no payment terms + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: 9e55a119-064e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 126 + details: + - name: Invoices + amount: 126 + - customerId: b30ca600-074e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116 + details: + - name: Invoices + amount: 116 + - customerId: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Trey Researches + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24 + details: + - name: CreditNotes + amount: -24 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2663.38 + details: + - name: Payments + amount: 10 + - name: Invoices + amount: 2653.38 + - customerId: d93ceb37-b805-ec11-86bc-0022481a45c2 + customerName: Vegan Bakeshop + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -18.67 + details: + - name: Payments + amount: -18.67 + FreshBooks: + value: + generated: '2023-05-02T16:05:20.6173310Z' + reportDate: '2023-05-02T16:05:20.5039554Z' + data: + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1 + details: + - name: Payments + amount: -1 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -500 + details: + - name: Payments + amount: -500 + - name: Invoices + amount: 0 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Payments + amount: -100 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -49 + details: + - name: Payments + amount: -49 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: '602174' + customerName: ab1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 222.71 + details: + - name: Invoices + amount: 222.71 + - currency: AED + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - customerId: '511657' + customerName: Bob's Stationary + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2060.2 + details: + - name: Payments + amount: -2083.83 + - name: Invoices + amount: 23.63 + - customerId: '581145' + customerName: CanadaCo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -132.15 + details: + - name: Payments + amount: -160.9 + - name: Invoices + amount: 28.75 + - currency: CNY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.88 + details: + - name: Invoices + amount: 2.88 + - customerId: '578409' + customerName: company1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1031.45 + details: + - name: Invoices + amount: 144 + - name: Payments + amount: -1175.45 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100.29 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100.29 + - customerId: '669531' + customerName: P + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24.98 + details: + - name: Invoices + amount: 24.98 + - customerId: '515655' + customerName: Parent company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2898.25 + details: + - name: Payments + amount: -2898.25 + - name: Invoices + amount: 0 + - customerId: '511669' + customerName: Pens International + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 516.3 + details: + - name: Payments + amount: 0 + - name: Invoices + amount: 516.3 + - customerId: '582461' + customerName: QA Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -76 + details: + - name: Invoices + amount: 20 + - name: Payments + amount: -96 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1.15 + details: + - name: Payments + amount: -1.15 + - customerId: '511661' + customerName: Sarah's Office Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - customerId: '572047' + customerName: SRS Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 141.25 + details: + - name: Invoices + amount: 141.25 + - customerId: '536295' + customerName: Test company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -144.46 + details: + - name: Invoices + amount: 7.64 + - name: Payments + amount: -152.1 + - customerId: '512927' + customerName: Wood Turnerss + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48442.07 + details: + - name: Invoices + amount: 51089.28 + - name: Payments + amount: -2647.21 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - currency: CAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.28 + details: + - name: Invoices + amount: 1186.28 + - name: Payments + amount: -994 + KashFlow: + value: + generated: '2023-05-02T16:05:20.3727270Z' + reportDate: '2023-05-02T16:05:20.3123550Z' + data: + - customerId: '88459410' + customerName: Diogo Sousa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 482.57 + details: + - name: Invoices + amount: 482.57 + - customerId: '86810130' + customerName: Maria Gomez + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -216 + details: + - name: Invoices + amount: -216 + - customerId: '86832299' + customerName: Mr French Person + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - customerId: '69946501' + customerName: Peter Lord + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3 + details: + - name: Invoices + amount: 3 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46 + details: + - name: CreditNotes + amount: -46 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55661.49 + details: + - name: Invoices + amount: 55911.49 + - name: Payments + amount: -250 + - customerId: '88353693' + customerName: Test Customer updated + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4771.03 + details: + - name: Invoices + amount: 4771.03 + - customerId: '69952389' + customerName: Things Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.42 + details: + - name: CreditNotes + amount: -42.42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6385 + details: + - name: Invoices + amount: 6385 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.0942911Z' + reportDate: '2023-05-02T16:05:20.8602315Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.0339587Z' + reportDate: '2023-05-02T16:05:19.8669114Z' + data: [] + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:19.9204890Z' + reportDate: '2023-05-02T16:05:19.8723073Z' + data: + - customerId: 1F0000-933272658 + customerName: 'Jacobsen, Doug' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 7991.52 + details: + - name: Invoices + amount: 7991.52 + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 6F0000-1071510646 + customerName: 'Morgenthaler, Jenny' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -271.53 + details: + - name: Payments + amount: -271.53 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.0640297Z' + reportDate: '2023-05-02T16:05:20.9965545Z' + data: + - customerId: '67' + customerName: Abercrombie International Group + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -837.11 + details: + - name: CreditNotes + amount: -837.11 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55512.84 + details: + - name: Invoices + amount: 55578.69 + - name: Payments + amount: -65.85 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '4' + customerName: Cathy's Consulting Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -905.8 + details: + - name: Invoices + amount: 314.2 + - name: Payments + amount: -1220 + - customerId: '20' + customerName: Chadha's Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -75 + details: + - name: Payments + amount: -75 + - customerId: '7' + customerName: Clement's Cleaners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24 + details: + - name: Invoices + amount: 24 + - customerId: '301' + customerName: Codat Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -650.27 + details: + - name: Invoices + amount: 15 + - name: CreditNotes + amount: -469.52 + - name: Payments + amount: -195.75 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 266.49 + details: + - name: Invoices + amount: 210.01 + - name: Payments + amount: 56.48 + - customerId: '305' + customerName: Codat Customer (USD) + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.5 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: 121.5 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '136' + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.37 + details: + - name: Payments + amount: 13.37 + - customerId: '218' + customerName: Diego Trantow + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11.65 + details: + - name: Payments + amount: 11.65 + - customerId: '8' + customerName: Ecker Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2273 + details: + - name: Invoices + amount: 2273 + - customerId: '59' + customerName: Ecker Holiday event + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3206779 + details: + - name: Invoices + amount: 3206779 + - customerId: '13' + customerName: Himateja Madala + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100 + - customerId: '11' + customerName: Ho Engineering Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: '114' + customerName: huw default not included + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116.4 + details: + - name: Invoices + amount: 116.4 + - customerId: '117' + customerName: Huw's Test Push customer2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -521.4 + details: + - name: CreditNotes + amount: -521.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1120.6 + details: + - name: Invoices + amount: 1232.2 + - name: Payments + amount: -111.6 + - customerId: '306' + customerName: J Codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.1 + details: + - name: Invoices + amount: 176.1 + - name: Payments + amount: -144 + - customerId: '15' + customerName: Jen Zaccarella + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4800 + details: + - name: Invoices + amount: 4800 + - customerId: '307' + customerName: Jo Codat 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 112.6 + details: + - name: Invoices + amount: 143.96 + - name: Payments + amount: 58.14 + - name: CreditNotes + amount: -89.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '119' + customerName: John Smith 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 160 + details: + - name: Invoices + amount: 160 + - customerId: '16' + customerName: Jordan Burgess + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1098 + details: + - name: CreditNotes + amount: -1098 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -60 + - customerId: '83' + customerName: Kay's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8508.37 + details: + - name: Invoices + amount: 8717.33 + - name: Payments + amount: -208.96 + - customerId: '1' + customerName: Ko International Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3586.2 + details: + - name: CreditNotes + amount: -3586.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11291.4 + details: + - name: Invoices + amount: 11474.05 + - name: Payments + amount: -182.65 + - customerId: '91' + customerName: Mr Huw Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2311.27 + details: + - name: CreditNotes + amount: -2311.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2292.91 + details: + - name: Invoices + amount: 2290.91 + - name: Payments + amount: 2 + - customerId: '55' + customerName: Oxon Insurance - Holiday Party + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10800 + details: + - name: Payments + amount: -10800 + - customerId: '70' + customerName: Project X + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50 + details: + - name: Invoices + amount: 50 + - customerId: '281' + customerName: Renee O'Connell + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12.75 + details: + - name: Payments + amount: 12.75 + - customerId: '118' + customerName: RSP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Payments + amount: 100 + - customerId: '76' + customerName: TestPushCustomer5 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1320 + details: + - name: Invoices + amount: 1320 + - customerId: '77' + customerName: TestPushCustomer6 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1848 + details: + - name: Invoices + amount: 1848 + - customerId: '79' + customerName: TestPushCustomer7 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -25 + details: + - name: Payments + amount: -25 + - customerId: '84' + customerName: Vegan Cake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -86.4 + details: + - name: CreditNotes + amount: -116.4 + - name: Payments + amount: 30 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -206460.15 + details: + - name: Invoices + amount: 5145.29 + - name: Payments + amount: -211605.44 + - customerId: '60' + customerName: Whitehead - Employee celebration + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1100 + details: + - name: CreditNotes + amount: -1100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '5' + customerName: Whitehead and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 754.4 + details: + - name: Invoices + amount: 754.4 + - customerId: '3' + customerName: Yeung's Architects + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -600 + details: + - name: CreditNotes + amount: -600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 20035.25 + details: + - name: Invoices + amount: 20604.49 + - name: Payments + amount: -569.24 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.5553019Z' + reportDate: '2023-05-02T16:05:20.4958267Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -378 + details: + - name: CreditNotes + amount: -378 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4504.07 + details: + - name: Invoices + amount: 4505.07 + - name: Payments + amount: -1 + - customerId: A1D002 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -66 + details: + - name: CreditNotes + amount: -66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 540 + details: + - name: Invoices + amount: 540 + - customerId: A1D003 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24.71 + details: + - name: CreditNotes + amount: -24.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 16606.32 + details: + - name: Invoices + amount: 16606.32 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -177.14 + details: + - name: CreditNotes + amount: -177.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4345.3 + details: + - name: Invoices + amount: 4845.3 + - name: Payments + amount: -500 + - customerId: USA1 + customerName: American Sales + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.16 + details: + - name: CreditNotes + amount: -103.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4284.77 + details: + - name: Invoices + amount: 4309.77 + - name: Payments + amount: -25 + - customerId: BRO001 + customerName: Bronson Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 786.48 + details: + - name: Invoices + amount: 852 + - name: Payments + amount: -65.52 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2274.62 + details: + - name: Invoices + amount: 2374.62 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 324.5 + details: + - name: Invoices + amount: 324.5 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4571.04 + details: + - name: Invoices + amount: 4571.04 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11260.26 + details: + - name: Invoices + amount: 11260.26 + - customerId: BRI001 + customerName: Fred Briant + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 536.67 + details: + - name: Invoices + amount: 656.67 + - name: Payments + amount: -120 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.09 + details: + - name: Invoices + amount: 4149.09 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2082.96 + details: + - name: Invoices + amount: 2082.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1228.34 + details: + - name: Invoices + amount: 1228.34 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9254.03 + details: + - name: Invoices + amount: 9254.03 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6927.26 + details: + - name: Invoices + amount: 6927.26 + - customerId: 1A2B3C + customerName: Maria Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 69.12 + details: + - name: Invoices + amount: 69.12 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3597.16 + details: + - name: Invoices + amount: 3597.16 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5644.12 + details: + - name: Invoices + amount: 6644.12 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 392.67 + details: + - name: Invoices + amount: 1767.67 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -168 + details: + - name: CreditNotes + amount: -168 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2106.84 + details: + - name: Invoices + amount: 2106.84 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 546.12 + details: + - name: Invoices + amount: 1413.9 + - name: Payments + amount: -867.78 + - customerId: RSP001 + customerName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -29210 + details: + - name: CreditNotes + amount: -29210 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 623907.28 + details: + - name: Invoices + amount: 624053.94 + - name: Payments + amount: -146.66 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4550.2 + details: + - name: Invoices + amount: 4550.2 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: '0001' + customerName: Test Customer01 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -366.71 + details: + - name: CreditNotes + amount: -366.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900.22 + details: + - name: Invoices + amount: 913.38 + - name: Payments + amount: -13.16 + - customerId: TESTSUPP + customerName: Test supplier for testing purposes 1234567891234567891234567 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 149.61 + details: + - name: Invoices + amount: 149.61 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7148.07 + details: + - name: Invoices + amount: 7148.07 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.66 + details: + - name: Invoices + amount: 2041.66 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:19.8072734Z' + reportDate: '2023-05-02T16:05:19.7472225Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.37 + details: + - name: Invoices + amount: -5.37 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2454.97 + details: + - name: Invoices + amount: 2454.97 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4309.77 + details: + - name: Invoices + amount: 4309.77 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2066.61 + details: + - name: Invoices + amount: 2166.61 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.01 + details: + - name: Invoices + amount: -0.01 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2749.02 + details: + - name: Invoices + amount: 2749.02 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11256.18 + details: + - name: Invoices + amount: 11256.18 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.08 + details: + - name: Invoices + amount: 4149.08 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1965.96 + details: + - name: Invoices + amount: 1965.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 977.09 + details: + - name: Invoices + amount: 977.09 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7398.33 + details: + - name: Invoices + amount: 7398.33 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6916.46 + details: + - name: Invoices + amount: 6916.46 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3525.26 + details: + - name: Invoices + amount: 3525.26 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2307.84 + details: + - name: Invoices + amount: 3307.84 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 370.27 + details: + - name: Invoices + amount: 1745.27 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2115.77 + details: + - name: Invoices + amount: 2115.77 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 268.93 + details: + - name: Invoices + amount: 1136.71 + - name: Payments + amount: -867.78 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4530.98 + details: + - name: Invoices + amount: 4530.98 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE002 + customerName: Steven Stephenson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8.35 + details: + - name: Invoices + amount: 8.35 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7305.77 + details: + - name: Invoices + amount: 7305.77 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.64 + details: + - name: Invoices + amount: 2041.64 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:20.9416221Z' + reportDate: '2023-05-02T16:05:20.7435694Z' + data: + - customerId: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: CreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1471 + details: + - name: Invoices + amount: 1891 + - name: Payments + amount: -420 + - customerId: 860dd9f1ad9346ba85117aedfa19cc72 + customerName: 100 test name DS + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1065 + details: + - name: Invoices + amount: 1080 + - name: Payments + amount: -15 + - customerId: 395d26ee8ab44f8b861b468caf63b00d + customerName: 222 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: CreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2443.8 + details: + - name: Invoices + amount: 2759.8 + - name: Payments + amount: -316 + - customerId: 013cf04960924a0da800f019369c3262 + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.66 + details: + - name: Invoices + amount: 9.34 + - name: Payments + amount: -10 + - customerId: 4ba77efb904e4380accc242b1526ac2c + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65 + details: + - name: Invoices + amount: 65 + - customerId: 18e45991fe6440ad8e8b5ecf9a2e7e09 + customerName: 444 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -50 + - customerId: 23ca7ffaa2b54360937531dde804c9aa + customerName: aaa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -22 + details: + - name: CreditNotes + amount: -22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -62 + details: + - name: Invoices + amount: 7 + - name: Payments + amount: -69 + - customerId: 2b93da6ce4af4dc99520eafd28768457 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 288 + details: + - name: Invoices + amount: 288 + - customerId: 460af92dd82a4a61b6ce1d18245789b3 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: b8bd7e0dfdd64d39abaaf2dcd1c48b49 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -119.99 + details: + - name: CreditNotes + amount: -119.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: aa37b59417024d2494f01ba23d92a2ef + customerName: Abe The Engineer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1562 + details: + - name: CreditNotes + amount: -1562 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1337 + details: + - name: Invoices + amount: 1362 + - name: Payments + amount: -25 + - customerId: df65eaa6789111e8aaa5027d54329956 + customerName: Baguettes Ltd + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -844.99 + details: + - name: CreditNotes + amount: -844.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 616726.02 + details: + - name: Invoices + amount: 617888.74 + - name: Payments + amount: -1162.72 + - customerId: 2916114b3b6942a7b08f1bcc971f5bf9 + customerName: c.taylor@codat.io + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Invoices + amount: 1.2 + - customerId: 0556b365ef4e42068fff775f847c0330 + customerName: Customer 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: Payments + amount: -701 + - customerId: 145dee01b49c4359a052682f234007e3 + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: 76f656dfbafa4cec823f1e2e43ea1a8e + customerName: Customer Test 59 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: a11e6776ca9a4e16af3425982de25a22 + customerName: Debs Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5279.2 + details: + - name: Invoices + amount: 5279.2 + - customerId: cc80e0fb747e4ddaab743d778d04ec4a + customerName: Debs US Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15111 + details: + - name: Invoices + amount: 15111 + - customerId: adb9cae8b34e446da3d53305b299168b + customerName: Fo Shizzle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: cc745370213545f6bd4129a7502f19fb + customerName: Grace Lo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1150 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -1150 + - customerId: 3b17c5ae9caf4b88a4a9e33a83fa321d + customerName: Hello + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Invoices + amount: 12 + - customerId: 979c5156ea0e45d9a9ea7b9d54775138 + customerName: J Customer FR + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -52795 + details: + - name: CreditNotes + amount: -52795 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 134045 + details: + - name: Invoices + amount: 134045 + - customerId: 99d52ca7060341a698a664d1737663c5 + customerName: J Customer UK + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -265 + details: + - name: CreditNotes + amount: -265 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15 + details: + - name: Invoices + amount: 30 + - name: Payments + amount: -15 + - customerId: f40870d5b704407481be14f780122d4f + customerName: J Customer US + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -161570 + details: + - name: CreditNotes + amount: -161570 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 181372 + details: + - name: Invoices + amount: 181372 + - customerId: 50a66e9756d2416d946419948bcf3631 + customerName: J Customer ZA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 0328dd6b109a4a6cbcb3d1a73f1d541b + customerName: James Arroyo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -719 + details: + - name: Invoices + amount: 178 + - name: Payments + amount: -897 + - customerId: bca2a47d7b4549c79b0c092d26b6661c + customerName: Jay Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25.01 + details: + - name: Invoices + amount: 25.01 + - customerId: 6477be6d012b4d48b4c160c098645c1c + customerName: Jo's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -37.8 + details: + - name: CreditNotes + amount: -37.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22.25 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -25.75 + - customerId: 097305a078ba473c884d2519ab290e57 + customerName: John QuickEntry Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: eac978a7622e4ef8b8d3af661f0cfdd3 + customerName: John Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Invoices + amount: 200 + - customerId: 3cc3148bbd8111e8bad90617b3da4b8a + customerName: John's Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1081.2 + details: + - name: CreditNotes + amount: -1081.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3379 + details: + - name: Invoices + amount: 3479 + - name: Payments + amount: -100 + - customerId: f66deccde15843ef80a82daad887146b + customerName: Kiran testing 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 6e921696a21a45c891ff4716a18e7649 + customerName: M Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900 + details: + - name: Invoices + amount: 900 + - customerId: bbb0582a0d054f5db268e570b50b4d6c + customerName: Mark Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 40 + details: + - name: Invoices + amount: 40 + - customerId: 440ba2199c07426a93e8edc1beb09791 + customerName: Matt Ager test EUR customer + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -8159.78 + details: + - name: CreditNotes + amount: -8159.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6016.67 + details: + - name: Invoices + amount: 6022.98 + - name: Payments + amount: -6.31 + - customerId: d430ed86b05645d7af0a630dae5d11d2 + customerName: Matthew Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 240 + details: + - name: Invoices + amount: 240 + - customerId: 9e8c3d82a2164ad29e29ab3a09ddf382 + customerName: Morv Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: fbdd38adb5b4441ebb200b83700d7ea5 + customerName: My Shop Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -384 + details: + - name: CreditNotes + amount: -384 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 398 + details: + - name: Invoices + amount: 398 + - customerId: 4b4cc40d998f47c3bec92fc088dcf327 + customerName: Nicoletta Carchia + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 90 + details: + - name: Invoices + amount: 90 + - customerId: ed070b1768bb4dd295e2a544a74c8ec0 + customerName: Paige Burlingham + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: CreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 84709d3f01a4462eb7f1527718f525f4 + customerName: SageOneCustomer.BusinessName + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1085 + details: + - name: CreditNotes + amount: -1085 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 90c438274d0b43759407da704394c104 + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.2 + details: + - name: CreditNotes + amount: -16.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1137.2 + details: + - name: Invoices + amount: 1137.2 + - customerId: 762e6895c1ff43f988f35fb507e20dd9 + customerName: Test Custiomer 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -615 + details: + - name: CreditNotes + amount: -615 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2178.25 + details: + - name: Invoices + amount: 2178.25 + - customerId: 7b9c18af4b66454b9f7e9409eb7da123 + customerName: Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Invoices + amount: 1200 + - customerId: 4ccf5c5fa14046ecb591e0620d87ea2e + customerName: Test Customer 3 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: CreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 499971 + details: + - name: Invoices + amount: 499971 + - customerId: f4ff85ba33dd11e797950a57719b2edb + customerName: Widgets Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23206.12 + details: + - name: CreditNotes + amount: -23206.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 733824.64 + details: + - name: Invoices + amount: 739536.49 + - name: Payments + amount: -5711.85 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.6557479Z' + reportDate: '2023-05-02T16:05:22.6081858Z' + data: + - customerId: '6' + customerName: AG Insurance + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 180 + details: + - name: Invoices + amount: 180 + - customerId: '531' + customerName: Shoprite + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: Payments + amount: -150 + Xero: + value: + generated: '2023-05-02T16:05:20.0730291Z' + reportDate: '2023-05-02T16:05:20.0102278Z' + data: + - customerId: 305ca5cf-497d-4fee-a161-cdb30e6be989 + customerName: Basket Case + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 914.55 + details: + - name: Invoices + amount: 914.55 + - customerId: 362819c9-f285-4d09-ac95-26327863adac + customerName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3434 + details: + - name: Invoices + amount: 3434 + - customerId: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + customerName: Boom FM + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1623.75 + details: + - name: Invoices + amount: 1623.75 + - customerId: c523e12f-8b74-4d3a-bbd8-32d7a2f598b4 + customerName: City Limousines + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1169.95 + details: + - name: Invoices + amount: 1169.95 + - customerId: 1262c350-fe0f-40ec-aeff-41c95b4a45af + customerName: DIISR - Small Business Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4470.63 + details: + - name: Invoices + amount: 4470.63 + - customerId: 94cb6d7b-5291-49f3-a0bc-fc0c01e68575 + customerName: Marine Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: 847933f0-7c35-4e5b-b884-5f9df64c8e4b + customerName: Port & Philip Freight + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2245 + details: + - name: Invoices + amount: 2245 + - customerId: a871a956-05b5-4e2a-9419-7aeb478ca647 + customerName: Ridgeway University + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6187.5 + details: + - name: Invoices + amount: 6187.5 + Zoho Books: + value: + generated: '2023-05-02T16:05:23.2078272Z' + reportDate: '2023-05-02T16:05:23.1573589Z' + data: + - customerId: '104957000000054050' + customerName: 'Doe, John' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10567 + details: + - name: CreditNotes + amount: -10567 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 38965 + details: + - name: Invoices + amount: 39865 + - name: Payments + amount: -900 + - customerId: '104957000000634160' + customerName: Dr. Jekyll + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -110 + details: + - name: CreditNotes + amount: -110 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000080010' + customerName: Max Mustermann + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -68 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -68 + - customerId: '104957000000277089' + customerName: Miss. No Contact Persons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: '104957000000054080' + customerName: Ms. Jane Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -465 + details: + - name: CreditNotes + amount: -465 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000277001' + customerName: 'Sousa, Diogo' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9001 + details: + - name: Invoices + amount: 9001 + - customerId: '104957000000037097' + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9001 + details: + - name: CreditNotes + amount: -9001 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3556.98 + details: + - name: Invoices + amount: 4501 + - name: Payments + amount: -944.02 + - customerId: '104957000001497001' + customerName: Will Westrop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Invoices + amount: 56 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: Aged creditors report available + description: Indicates whether the aged creditor report is available for the company. + operationId: is-aged-creditors-report-available + x-speakeasy-name-override: is-aged-creditors-available + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged creditors report + description: Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. + operationId: get-accounting-aged-creditors-report + x-speakeasy-name-override: get-aged-creditors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedCreditorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.7545859Z' + reportDate: '2023-05-02T16:05:21.7016767Z' + data: + - supplierId: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -78.12 + details: + - name: BillCreditNotes + amount: -78.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 375.6 + details: + - name: Bills + amount: 375.6 + - supplierId: FyUkHbZxhn + supplierName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3782.27 + details: + - name: BillCreditNotes + amount: -3782.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8556.1 + details: + - name: Bills + amount: 8556.1 + - supplierId: gxazX5hqx4 + supplierName: Bernier Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 213.19 + details: + - name: Bills + amount: 213.19 + - supplierId: ro8nWYGzlg + supplierName: Botsford - Hickle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2242.95 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2242.95 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 838.67 + details: + - name: Bills + amount: 838.67 + - supplierId: D4Q4iYwHou + supplierName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276.5 + details: + - name: BillCreditNotes + amount: -276.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46060.53 + details: + - name: Bills + amount: 46060.53 + - supplierId: 9436ead6-545e-4e8c-8444-0220047c5a38 + supplierName: Champlin LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22726.97 + details: + - name: Bills + amount: 22726.97 + - supplierId: O6jExrbN3v + supplierName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -19.39 + details: + - name: BillCreditNotes + amount: -19.39 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9d4b61a4-4ce3-4d90-8d6b-66614694dc27 + supplierName: Crona - Adams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 302.8 + details: + - name: Bills + amount: 302.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: ad8f4ee1-7a04-415f-b3dc-365d41d8d4f0 + supplierName: 'Cronin, Kunde and Tremblay' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3271.91 + details: + - name: BillCreditNotes + amount: -3271.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3479.78 + details: + - name: Bills + amount: 3479.78 + - supplierId: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16511.91 + details: + - name: BillCreditNotes + amount: -16511.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: XOPP3v2lQu + supplierName: Fisher and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 238599.9 + details: + - name: Bills + amount: 238599.9 + - supplierId: 0a7b0432-7de3-4e29-bf15-4e7ca0722384 + supplierName: Flatley - Kirlin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -113.59 + details: + - name: BillCreditNotes + amount: -113.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 910.45 + details: + - name: Bills + amount: 910.45 + - supplierId: HrGZeW4I51 + supplierName: 'Frami, Simonis and Krajcik' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2070.59 + details: + - name: BillCreditNotes + amount: -2070.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: SFmBGSHLQ3 + supplierName: Gottlieb LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.07 + details: + - name: BillCreditNotes + amount: -105.07 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: unNIu8Uyap + supplierName: Hahn and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -297.78 + details: + - name: BillCreditNotes + amount: -297.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2095.75 + details: + - name: Bills + amount: 2095.75 + - supplierId: GTGS3Sx241 + supplierName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3612.41 + details: + - name: Bills + amount: 3612.41 + - supplierId: w07H3CBm5P + supplierName: 'Hayes, Predovic and Ruecker' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -11662.51 + details: + - name: BillCreditNotes + amount: -11662.51 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 393776.18 + details: + - name: Bills + amount: 393776.18 + - supplierId: 92144542-2227-409e-8f5b-fc73260e670b + supplierName: 'Hettinger, Schmitt and Will' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 3433.54 + details: + - name: Bills + amount: 3433.54 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: rpLhEYz0ML + supplierName: Hickle - Buckridge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7484.88 + details: + - name: BillCreditNotes + amount: -7484.88 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2056eb9-649e-4808-8f96-d8ea4dac71fe + supplierName: Hodkiewicz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6627.16 + details: + - name: BillCreditNotes + amount: -6627.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18266.27 + details: + - name: Bills + amount: 18266.27 + - supplierId: s3WcvMyVdR + supplierName: Howe - Ruecker + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4042.16 + details: + - name: Bills + amount: 4042.16 + - supplierId: b60XbI9zhE + supplierName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12938.29 + details: + - name: BillCreditNotes + amount: -12938.29 + - name: Bills + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18360.8 + details: + - name: Bills + amount: 18360.8 + - supplierId: OtXKRTOcQc + supplierName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190.16 + details: + - name: Bills + amount: 190.16 + - supplierId: c02bc2f1-631d-4721-aec1-a190d63e8322 + supplierName: Jones - Zulauf + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69.05 + details: + - name: BillCreditNotes + amount: -69.05 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51357.36 + details: + - name: Bills + amount: 51357.36 + - supplierId: c02382bd-ff23-4b34-bfd7-8dce15fa7d6a + supplierName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2496.69 + details: + - name: BillCreditNotes + amount: -2496.69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1519.74 + details: + - name: Bills + amount: 1519.74 + - supplierId: d3tf43eghS + supplierName: Klocko - Keebler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12367.4 + details: + - name: Bills + amount: 12367.4 + - supplierId: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -318.71 + details: + - name: BillCreditNotes + amount: -318.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: gO8p5O3Mvy + supplierName: Lehner Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1042.8 + details: + - name: BillCreditNotes + amount: -1042.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 62229022-713f-4c64-84f2-63cf6dd11443 + supplierName: Littel - Cole + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7.5 + details: + - name: BillCreditNotes + amount: -7.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 39b32019-c5d0-4db3-ae83-f0a644e614ef + supplierName: Marvin - Schaden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1611.56 + details: + - name: BillCreditNotes + amount: -1611.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 8635b986-048f-424c-985d-912576c004d9 + supplierName: 'Mills, Bechtelar and Wintheiser' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -604.41 + details: + - name: BillCreditNotes + amount: -604.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2fb1aba-79ac-4840-95d5-6c173c9beaad + supplierName: Morissette LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55.93 + details: + - name: BillCreditNotes + amount: -55.93 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 27dc0345-aae8-4b69-a903-fed6b0a8778b + supplierName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1546.46 + details: + - name: Bills + amount: 1546.46 + - supplierId: 0d892acd-4b56-4412-80ee-381b8118637b + supplierName: Nicolas - McKenzie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -186.97 + details: + - name: BillCreditNotes + amount: -186.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5131.74 + details: + - name: Bills + amount: 5131.74 + - supplierId: cc283863-960f-42f8-8e38-1e22235e9cfc + supplierName: Nicolas Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6.41 + details: + - name: BillCreditNotes + amount: -6.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9UvJVVmPHO + supplierName: Nienow - Schroeder + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2822.41 + details: + - name: BillCreditNotes + amount: -2822.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 1346295c-2970-47a7-8a99-1f935567db02 + supplierName: Polly Crona + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3600.36 + details: + - name: Bills + amount: 3600.36 + - supplierId: 5fcb09bf-ae92-42a1-a69b-57c5f0ebedd9 + supplierName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2938.85 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2938.85 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 4253a13e-638e-4a42-9e61-665a60267a48 + supplierName: 'Robel, Ledner and Stroman' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1106.72 + details: + - name: Bills + amount: 1106.72 + - supplierId: 143ed2c5-2623-465e-a015-5ac12df75aa6 + supplierName: Schulist - Douglas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12468.22 + details: + - name: BillCreditNotes + amount: -12468.22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 39306.44 + details: + - name: Bills + amount: 39306.44 + - supplierId: d770b767-489e-455b-9d32-29c37a1b9d07 + supplierName: Schultz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -517.52 + details: + - name: BillCreditNotes + amount: -517.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 98e93284-fcaa-440c-8f86-f36e5df591da + supplierName: Simonis - Ziemann + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -597.01 + details: + - name: BillCreditNotes + amount: -597.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 87e907ed-97f8-4146-b276-fea2a10671bf + supplierName: Sporer and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -62443.6 + details: + - name: BillCreditNotes + amount: -62443.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 97682025-4e50-449f-8510-6d09d1d0f84b + supplierName: Sporer LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1104.37 + details: + - name: BillCreditNotes + amount: -1104.37 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1050.12 + details: + - name: Bills + amount: 1050.12 + - supplierId: c51351a0-b43f-48c6-8dbb-8417171bda67 + supplierName: Veum - Schiller + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1966.59 + details: + - name: BillCreditNotes + amount: -1966.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10234.97 + details: + - name: Bills + amount: 10234.97 + - supplierId: 26f6b56a-4a86-468f-a302-9d60bdc01d91 + supplierName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23450.31 + details: + - name: BillCreditNotes + amount: -23450.31 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: f589fd05-c5f8-4815-b205-0a9f3f0b3b96 + supplierName: Weber LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -681.79 + details: + - name: BillCreditNotes + amount: -681.79 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10221.45 + details: + - name: Bills + amount: 10221.45 + - supplierId: 1cc8b95c-62ec-415a-ab0e-facf7e7218bf + supplierName: 'Welch, Terry and Hermiston' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1219.54 + details: + - name: Bills + amount: 1219.54 + - supplierId: f6CgWtm1aw + supplierName: Wisoky Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 272.67 + details: + - name: Bills + amount: 272.67 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: je5ok1Cam5 + supplierName: 'Wunsch, Kerluke and West' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7238.24 + details: + - name: Bills + amount: 7238.24 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:21.1349781Z' + reportDate: '2023-05-02T16:05:21.0866594Z' + data: + - supplierId: e89328bd-485a-eb11-89fa-00224800af18 + supplierName: A QA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -526.8 + details: + - name: BillCreditNotes + amount: -526.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 120 + details: + - name: Bills + amount: 120 + - supplierId: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11904.4 + details: + - name: Bills + amount: 461.6 + - name: BillPayments + amount: -12366 + - currency: PLN + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -15 + details: + - name: BillPayments + amount: -15 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12123.81 + details: + - name: Bills + amount: 12128.81 + - name: BillPayments + amount: -5 + - supplierId: c21217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Graphic Design Institute + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7514.8 + details: + - name: Bills + amount: 7520.8 + - name: BillPayments + amount: -6 + - supplierId: 4a1b210e-b805-ec11-86bc-0022481a45c2 + supplierName: Kays Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -121 + details: + - name: BillPayments + amount: -121 + - supplierId: c61217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Nod Publishers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13156.74 + details: + - name: Bills + amount: 13156.74 + - supplierId: b864b5ae-4a5a-eb11-89fa-00224800af18 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3951 + details: + - name: Bills + amount: 3951 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.45 + details: + - name: Bills + amount: 121.45 + - supplierId: 8b4c95b4-b705-ec11-86bc-0022481a45c2 + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.27 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -5.27 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11.75 + details: + - name: BillPayments + amount: -11.75 + - supplierId: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15843.22 + details: + - name: Bills + amount: 15848.22 + - name: BillPayments + amount: -5 + Exact (Netherlands): + value: + generated: '2023-05-02T16:05:19.8312183Z' + reportDate: '2023-05-02T16:05:19.7538301Z' + data: + - supplierId: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -38.28 + details: + - name: BillCreditNotes + amount: -38.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1952.27 + details: + - name: Bills + amount: 1941.58 + - name: BillPayments + amount: 10.69 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10000 + details: + - name: BillCreditNotes + amount: -10000 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117 + details: + - name: Bills + amount: 117 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4997.25 + details: + - name: Bills + amount: 4997.25 + - supplierId: 78afea22-ee21-48c3-84d5-45b9b24768e9 + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 110 + details: + - name: Bills + amount: 108 + - name: BillPayments + amount: 2 + - supplierId: 773416a6-b196-487b-ae02-eeb273a86bcd + supplierName: Belastingdienst + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -293.14 + details: + - name: BillCreditNotes + amount: -293.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1547.08 + details: + - name: Bills + amount: 1547.08 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.17 + details: + - name: Bills + amount: 32.17 + - supplierId: 7017da1f-2d49-4601-abf3-c4e779459976 + supplierName: Bool Test + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121 + details: + - name: Bills + amount: 121 + - supplierId: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65.73 + details: + - name: BillCreditNotes + amount: -65.73 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -83351.62 + details: + - name: BillPayments + amount: -83381.63 + - name: Bills + amount: 30.01 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -8285.73 + details: + - name: BillPayments + amount: -8285.73 + - supplierId: 8cb6745b-4769-4c7a-9d92-bc688c60ca3c + supplierName: iZettle AB (Supplier) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 19.93 + details: + - name: Bills + amount: 19.93 + - supplierId: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: BillPayments + amount: 5 + - supplierId: acde3236-898e-4e68-b076-4e946defbc5f + supplierName: Matt Ager Test Supplier 1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276 + details: + - name: BillCreditNotes + amount: -276 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 75 + details: + - name: Bills + amount: 105 + - name: BillPayments + amount: -30 + - currency: RUB + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: BillPayments + amount: -10 + - supplierId: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12.1 + details: + - name: BillCreditNotes + amount: -12.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.97 + details: + - name: Bills + amount: 119.97 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7040 + details: + - name: BillCreditNotes + amount: -7040 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8800 + details: + - name: Bills + amount: 8800 + - supplierId: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.83 + details: + - name: Bills + amount: -0.83 + - supplierId: 1d2c9f47-a2fc-48e6-a967-71583d764b10 + supplierName: NLSuppliers07 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25 + details: + - name: Bills + amount: 25 + - supplierId: a1e88d58-caec-4ed6-ad1b-646ebb959c17 + supplierName: supplierrrr + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55 + details: + - name: BillCreditNotes + amount: -55 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11084 + details: + - name: Bills + amount: 11084 + - supplierId: cdcdce7b-0330-49fb-8169-0a50e0b74dcc + supplierName: Test NL sup1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.21 + details: + - name: BillPayments + amount: 13.21 + - supplierId: bad8020a-267f-41fb-9e0f-e93465ee9529 + supplierName: Test supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 718.22 + details: + - name: Bills + amount: 718.22 + - supplierId: 26bc5305-8613-43e4-ab97-522ade34cbba + supplierName: Vandana's Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 403.74 + details: + - name: Bills + amount: 403.74 + Exact (UK): + value: + generated: '2023-05-02T16:05:22.8960035Z' + reportDate: '2023-05-02T16:05:22.8283897Z' + data: + - supplierId: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 560.1 + details: + - name: Bills + amount: 660.1 + - name: BillPayments + amount: -100 + - supplierId: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -400 + details: + - name: BillCreditNotes + amount: -400 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 430 + - name: BillPayments + amount: -400 + - supplierId: 5f20075a-a28e-434d-81a6-2db0dc170e87 + supplierName: Abdi 99 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 609 + details: + - name: Bills + amount: 258 + - name: BillPayments + amount: 351 + - supplierId: 0d3f8692-4b0a-4bc3-85f2-4cb763306397 + supplierName: Ann's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3600 + details: + - name: BillCreditNotes + amount: -3600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2400 + details: + - name: Bills + amount: 2400 + - supplierId: fc62db43-a6f8-4b65-9d29-15290ec56674 + supplierName: Anna's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1717.5 + details: + - name: BillCreditNotes + amount: -1717.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2751 + details: + - name: Bills + amount: 2751 + - supplierId: cde51f36-2a06-4eac-9784-c0c967c1e1ed + supplierName: b + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6 + details: + - name: BillCreditNotes + amount: -6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 437c6631-3c5d-4351-b757-6ad4f94bd26e + supplierName: bb + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 220 + details: + - name: Bills + amount: 220 + - supplierId: fe713acb-3c98-423d-8372-68a32aae6232 + supplierName: cc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: BillPayments + amount: -60 + - supplierId: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100073.4 + details: + - name: BillCreditNotes + amount: -100073.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 374.8 + details: + - name: Bills + amount: 373.8 + - name: BillPayments + amount: 1 + - supplierId: 6a4c6a14-d5eb-4427-aae0-c544f67dff7a + supplierName: CustomerAndSupplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.05 + details: + - name: BillPayments + amount: 2.05 + - supplierId: efb5d438-7d3a-4b77-a254-2d90f76d3f22 + supplierName: dd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: 77b652bb-a363-4425-adbd-0206e2ce4639 + supplierName: e + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -72.33 + details: + - name: BillCreditNotes + amount: -72.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 133.6 + details: + - name: Bills + amount: 133.6 + - supplierId: 7c8a9143-7322-48e3-b809-88a038b8a0e0 + supplierName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.5 + details: + - name: Bills + amount: 192.5 + - supplierId: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1200 + details: + - name: BillCreditNotes + amount: -1200 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3837 + details: + - name: Bills + amount: 3837 + - supplierId: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46.8 + details: + - name: BillCreditNotes + amount: -46.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -54537.12 + details: + - name: Bills + amount: 455.73 + - name: BillPayments + amount: -54992.85 + FreeAgent: + value: + generated: '2023-05-02T16:05:23.3560058Z' + reportDate: '2023-05-02T16:05:23.3059155Z' + data: + - supplierId: '10123537' + supplierName: _Test 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 791 + details: + - name: Bills + amount: 791 + - currency: QAR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '11526230' + supplierName: '-' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6430 + details: + - name: Bills + amount: 1500 + - name: BillCreditNotes + amount: -7930 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: '9677150' + supplierName: '-' + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: '8959011' + supplierName: '1' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -134.3 + details: + - name: BillCreditNotes + amount: -134.3 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46 + details: + - name: Bills + amount: 46 + - supplierId: '6161941' + supplierName: A & J Fabtech Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2433.99 + details: + - name: BillCreditNotes + amount: -2433.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3431 + details: + - name: Bills + amount: 3431 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 400 + details: + - name: Bills + amount: 400 + - supplierId: '6161963' + supplierName: ABB Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: '9356878' + supplierName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '8984892' + supplierName: Abraham's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 77 + details: + - name: Bills + amount: 77 + - supplierId: '9273150' + supplierName: Best Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -456 + details: + - name: BillCreditNotes + amount: -456 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: '6161956' + supplierName: C Allen + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100 + details: + - name: BillCreditNotes + amount: -100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 122 + details: + - name: Bills + amount: 122 + - supplierId: '7994567' + supplierName: codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: '5730310' + supplierName: Demo Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '6162169' + supplierName: PricewaterhouseCoopers LLP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 42 + details: + - name: Bills + amount: 42 + - supplierId: '10672202' + supplierName: Random Org + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42 + details: + - name: BillCreditNotes + amount: -42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: '8989342' + supplierName: Supplier Hidden + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -500 + details: + - name: BillCreditNotes + amount: -500 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: BillPayments + amount: -150 + - supplierId: '7169654' + supplierName: The Eagle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -492 + details: + - name: BillCreditNotes + amount: -492 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3523.75 + details: + - name: Bills + amount: 3523.75 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 301 + details: + - name: Bills + amount: 301 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.5229720Z' + reportDate: '2023-05-02T16:05:21.2821865Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.3296968Z' + reportDate: '2023-05-02T16:05:20.2442587Z' + data: + - supplierId: '779' + supplierName: Test Vendor + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Bills + amount: 56 + - supplierId: '724' + supplierName: Vendor A.A.A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 579.55 + details: + - name: Bills + amount: 524 + - name: BillPayments + amount: 55.55 + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:20.3972104Z' + reportDate: '2023-05-02T16:05:20.3178060Z' + data: + - supplierId: B0000-933272656 + supplierName: Patton Hardware Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5000 + details: + - name: Bills + amount: 5000 + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.3065432Z' + reportDate: '2023-05-02T16:05:21.2488309Z' + data: + - supplierId: '129' + supplierName: Ally Johnson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 230.98 + details: + - name: Bills + amount: 276.38 + - name: BillPayments + amount: -45.4 + - supplierId: '88' + supplierName: Andrew Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16 + details: + - name: BillCreditNotes + amount: -16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 66.25 + details: + - name: BillPayments + amount: -13.75 + - name: Bills + amount: 80 + - supplierId: '53' + supplierName: Bank of AnyCity + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63 + details: + - name: Bills + amount: 63 + - supplierId: '282' + supplierName: Becky's Bakery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 490.5 + details: + - name: BillPayments + amount: -9.5 + - name: Bills + amount: 500 + - supplierId: '24' + supplierName: Brijesh Jain + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69 + details: + - name: BillCreditNotes + amount: -69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 52260 + details: + - name: Bills + amount: 52260 + - supplierId: '25' + supplierName: Brittney Hughes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 70 + details: + - name: Bills + amount: 70 + - supplierId: '26' + supplierName: Burc Gunes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33.05 + details: + - name: Bills + amount: 33.05 + - supplierId: '27' + supplierName: Cass Hayden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1450 + details: + - name: Bills + amount: 1500 + - name: BillPayments + amount: -50 + - supplierId: '51' + supplierName: City Water Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7.25 + details: + - name: Bills + amount: 24 + - name: BillPayments + amount: -16.75 + - supplierId: '297' + supplierName: Codat Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -128 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -25 + - name: BillCreditNotes + amount: -103 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -328.32 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -328.32 + - supplierId: '87' + supplierName: Costco + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -17.85 + details: + - name: BillPayments + amount: -17.85 + - supplierId: '57' + supplierName: Hall's Promo Items + agedCurrencyOutstanding: + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1041.09 + details: + - name: Bills + amount: 1041.09 + - supplierId: '92' + supplierName: Huw Thomas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25292 + details: + - name: Bills + amount: 25302 + - name: BillPayments + amount: -10 + - supplierId: '85' + supplierName: Jay's Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -446.83 + details: + - name: BillCreditNotes + amount: -446.83 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9759.68 + details: + - name: Bills + amount: 9822.46 + - name: BillPayments + amount: -62.78 + - supplierId: '34' + supplierName: Jennifer Hargreaves + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 239.01 + details: + - name: Bills + amount: 239.01 + - supplierId: '37' + supplierName: Kristina Gibson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1710 + details: + - name: BillCreditNotes + amount: -1710 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 502.38 + details: + - name: Bills + amount: 502.38 + - supplierId: '41' + supplierName: Mark Howard + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3000 + details: + - name: Bills + amount: 3000 + - supplierId: '23' + supplierName: Mr Andrew Thomas Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -21.2 + details: + - name: BillCreditNotes + amount: -21.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.09 + details: + - name: Bills + amount: 54.09 + - supplierId: '54' + supplierName: Organization of Outstanding Event Planners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 390 + details: + - name: Bills + amount: 390 + - supplierId: '47' + supplierName: Sanjeev Kak + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 21 + details: + - name: Bills + amount: 21 + - supplierId: '74' + supplierName: TestPushCustomer3 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '86' + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.76 + details: + - name: BillCreditNotes + amount: -42.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1249.3 + details: + - name: BillPayments + amount: -504.24 + - name: Bills + amount: 1753.54 + - supplierId: '58' + supplierName: Venue Rental + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 461 + details: + - name: Bills + amount: 500 + - name: BillPayments + amount: -39 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.7939148Z' + reportDate: '2023-05-02T16:05:20.7474542Z' + data: + - supplierId: CON002 + supplierName: Concept Stationery Sub A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 411.76 + details: + - name: Bills + amount: 782.56 + - name: BillPayments + amount: -370.8 + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -167.1 + details: + - name: BillCreditNotes + amount: -167.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5062.78 + details: + - name: Bills + amount: 5111.01 + - name: BillPayments + amount: -48.23 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25802.03 + details: + - name: Bills + amount: 25934.03 + - name: BillPayments + amount: -132 + - supplierId: MEA001 + supplierName: Mears Insurance + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: BillCreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1368.02 + details: + - name: Bills + amount: 1524 + - name: BillPayments + amount: -155.98 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -13.21 + details: + - name: BillCreditNotes + amount: -13.21 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1024.13 + details: + - name: Bills + amount: 1041.61 + - name: BillPayments + amount: -17.48 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.64 + details: + - name: BillCreditNotes + amount: -105.64 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 155.92 + details: + - name: Bills + amount: 155.92 + - supplierId: RSP002 + supplierName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60000 + details: + - name: Bills + amount: 60000 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1130.29 + details: + - name: Bills + amount: 1189.29 + - name: BillPayments + amount: -59 + - supplierId: STU001 + supplierName: Studio Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 562.06 + details: + - name: Bills + amount: 562.06 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2055.3 + details: + - name: Bills + amount: 2055.3 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9433.71 + details: + - name: Bills + amount: 9433.71 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 576.04 + details: + - name: Bills + amount: 1091.04 + - name: BillPayments + amount: -515 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1104.16 + details: + - name: Bills + amount: 1104.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -70.76 + details: + - name: BillCreditNotes + amount: -70.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -221.75 + details: + - name: Bills + amount: -121.75 + - name: BillPayments + amount: -100 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:20.0257207Z' + reportDate: '2023-05-02T16:05:19.9751677Z' + data: + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1644.39 + details: + - name: Bills + amount: 1644.39 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24734.12 + details: + - name: Bills + amount: 24734.12 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -0.01 + details: + - name: BillCreditNotes + amount: -0.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0.01 + details: + - name: Bills + amount: 0.01 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.63 + details: + - name: BillCreditNotes + amount: -42.63 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 72.85 + details: + - name: Bills + amount: 72.85 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 352.5 + details: + - name: Bills + amount: 352.5 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1762.5 + details: + - name: Bills + amount: 1762.5 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9164.95 + details: + - name: Bills + amount: 9164.95 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 472.24 + details: + - name: Bills + amount: 972.24 + - name: BillPayments + amount: -500 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 744.16 + details: + - name: Bills + amount: 744.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -58.76 + details: + - name: BillCreditNotes + amount: -58.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117.29 + details: + - name: Bills + amount: 117.29 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:21.3095542Z' + reportDate: '2023-05-02T16:05:21.1514485Z' + data: + - supplierId: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: BillCreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1548.84 + details: + - name: Bills + amount: 1608.84 + - name: BillPayments + amount: -60 + - supplierId: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -841570.32 + details: + - name: BillCreditNotes + amount: -841570.32 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 661901.14 + details: + - name: Bills + amount: 662062.14 + - name: BillPayments + amount: -161 + - supplierId: f82f0f59fbf44416b833562783388ee9 + supplierName: Abe's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -38.8 + details: + - name: Bills + amount: 1.2 + - name: BillPayments + amount: -40 + - supplierId: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -140.97 + details: + - name: BillCreditNotes + amount: -140.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1856307.16 + details: + - name: BillPayments + amount: -213 + - name: Bills + amount: 1856520.16 + - supplierId: b1354c4ae5db4d069acbcf49bee62215 + supplierName: Boyer Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 360000 + details: + - name: Bills + amount: 360000 + - supplierId: 46b3d6acedcb4738a9646dc512562cda + supplierName: callum + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Bills + amount: 1.2 + - supplierId: 7e7450fadbb94d09abdaf609a51d05eb + supplierName: Debs UK Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1814652 + details: + - name: Bills + amount: 1814652 + - supplierId: bf6fc20701264c899a1ba96365aa9d70 + supplierName: Eliana's + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.6 + details: + - name: BillCreditNotes + amount: -105.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 26.4 + details: + - name: Bills + amount: 26.4 + - supplierId: 30862a4b2c084a4fa2e640f9ef371e4c + supplierName: Flour Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60 + details: + - name: Bills + amount: 60 + - supplierId: 390ca10633cb4bf989961491e834b47a + supplierName: Jo Cheese + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9 + details: + - name: Bills + amount: 9 + - supplierId: b10be78d0e9340a79743c538a0b481d0 + supplierName: M7 Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65150090 + details: + - name: Bills + amount: 65150090 + - supplierId: 693d3b961e744b02a6a260f4bada75b0 + supplierName: Matt Ager Test EU Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6841.33 + details: + - name: BillCreditNotes + amount: -6841.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6841.33 + details: + - name: Bills + amount: 6841.33 + - supplierId: 1edf56c368e14a35a050b3e8336e2272 + supplierName: Mike B Commerce Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Bills + amount: 300 + - supplierId: c6d3fa5bf2634b148d0ee82b6fbb8fe3 + supplierName: my shop supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: BillCreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: cdeae2fcbe6447f698d2a59d68e4ad82 + supplierName: Nic Supp + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 2e14c8cfee3041a4a5e8a619b336f900 + supplierName: Nic Supplies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 30 + - supplierId: c41981674176495f927f46ce663d46ac + supplierName: Ninetta Ponting + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -306 + details: + - name: BillPayments + amount: -306 + - supplierId: e2dd680fed99410982673f8fc2722357 + supplierName: Supplier 70 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -70 + details: + - name: BillPayments + amount: -70 + - supplierId: 8d61f7cd3a2f4ceea26ac5bca15e10da + supplierName: Supplier 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: BillPayments + amount: -701 + - supplierId: 7a67caeb261f40259f0948785090af0b + supplierName: supplier test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12014.4 + details: + - name: Bills + amount: 12014.4 + - supplierId: d884f637bb3a4e589d640085b31ad6ee + supplierName: Tasty Treats Icecreams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -454 + details: + - name: BillCreditNotes + amount: -454 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 456 + details: + - name: Bills + amount: 456 + - supplierId: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1152.78 + details: + - name: BillCreditNotes + amount: -1152.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 14960.37 + details: + - name: Bills + amount: 15064.41 + - name: BillPayments + amount: -104.04 + - supplierId: 2541e491791c485a96cc480cfde112d6 + supplierName: Test Supplier 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: BillCreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63338524.47 + details: + - name: Bills + amount: 63338524.47 + - supplierId: 877aac191c3c40eda61115eea12641f7 + supplierName: Test Supplier 3 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3535.61 + details: + - name: BillCreditNotes + amount: -3535.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50658.58 + details: + - name: Bills + amount: 50658.58 + - supplierId: d98e7afb4ca846dfbb12ca285f95f863 + supplierName: Test Supplier 4 (US) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51872949 + details: + - name: Bills + amount: 51872949 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.9252709Z' + reportDate: '2023-05-02T16:05:22.8758390Z' + data: + - supplierId: '3' + supplierName: ADP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 487.5 + details: + - name: Bills + amount: 487.5 + - supplierId: '14' + supplierName: Kristofferson Consulting + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7200 + details: + - name: Bills + amount: 7200 + - supplierId: '7' + supplierName: Lenovo + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190 + details: + - name: Bills + amount: 190 + - supplierId: '8' + supplierName: Worldwide Commercial + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + Xero: + value: + generated: '2023-05-02T16:05:20.3006654Z' + reportDate: '2023-05-02T16:05:20.2587933Z' + data: + - supplierId: 699f0091-b127-4796-9f15-41a2f42abeb2 + supplierName: ABC Furniture + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: 362819c9-f285-4d09-ac95-26327863adac + supplierName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: 2dc0ef7c-582f-4542-963b-dbdc069e4819 + supplierName: Bayside Wholesale + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 961.21 + details: + - name: Bills + amount: 961.21 + - supplierId: 51cbbfb0-8dc9-41aa-aad6-eb93b3cc40c6 + supplierName: Capital Cab Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 242 + details: + - name: Bills + amount: 242 + - supplierId: 3828f379-afa5-4b2a-9000-9c53d75ba1c6 + supplierName: Central Copiers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1063.56 + details: + - name: Bills + amount: 1063.56 + - supplierId: 8a593982-291c-4ec3-9a42-3dbccbc6e3c8 + supplierName: MCO Cleaning Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.08 + details: + - name: Bills + amount: 119.08 + - supplierId: 97cc88ca-f89b-41f0-b8b9-e750b6f2f1d9 + supplierName: Net Connect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.13 + details: + - name: Bills + amount: 54.13 + - supplierId: dec56ceb-65e9-43b3-ac98-7fe09eb37e31 + supplierName: PowerDirect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 244.45 + details: + - name: Bills + amount: 244.45 + - supplierId: f5a77e82-50e3-4340-a6e0-13d6a482a08a + supplierName: SMART Agency + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4500 + details: + - name: Bills + amount: 4500 + - supplierId: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 93.64 + details: + - name: Bills + amount: 93.64 + - supplierId: ac48c67d-3eea-44eb-96b1-9f7a89d9b761 + supplierName: Xero + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56.35 + details: + - name: Bills + amount: 56.35 + - supplierId: 94a82e91-53da-4f87-a417-63d6a1607ced + supplierName: Young Bros Transport + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 125.03 + details: + - name: Bills + amount: 125.03 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/balanceSheet': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get balance sheet + description: Gets the latest balance sheet for a company. + operationId: get-accounting-balance-sheet + x-speakeasy-group: financial-statements.balance-sheet + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBalanceSheet' + examples: + Clear Books: + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 4643976.27 + items: + - accountId: '' + name: Fixed Assets + value: 3930291.27 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2354838.89 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1575452.38 + items: [] + - accountId: '' + name: Current Assets + value: 713685 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 66538.63 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 27250.93 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 113157.44 + items: [] + - accountId: '' + name: Bank + value: 506738 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 506738 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1183797.31 + items: + - accountId: '' + name: Current Liabilities + value: 544797.71 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 27683.3 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 8985.44 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 36981.83 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1193.59 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1147.11 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 439935.82 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 28870.62 + items: [] + - accountId: '' + name: Long Term Liability + value: 638999.6 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 638999.6 + items: [] + netAssets: 3460178.96 + equity: + accountId: '' + name: Equity + value: 3460178.96 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 54977.57 + items: [] + - date: '2023-02-28T00:00:00' + assets: + accountId: '' + name: Assets + value: 4599890.71 + items: + - accountId: '' + name: Fixed Assets + value: 3882793.51 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2036803.36 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1845990.15 + items: [] + - accountId: '' + name: Current Assets + value: 717097.2 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 136245.44 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 18719.25 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 146898.62 + items: [] + - accountId: '' + name: Bank + value: 415233.89 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 415233.89 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1150262.51 + items: + - accountId: '' + name: Current Liabilities + value: 508579.57 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 22517.83 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 5994.86 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 49993.06 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1424.88 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1863.01 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 399839.88 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 26946.05 + items: [] + - accountId: '' + name: Long Term Liability + value: 641682.94 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 641682.94 + items: [] + netAssets: 3449628.2 + equity: + accountId: '' + name: Equity + value: 3449628.19 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 44426.8 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + currency: GBP + reports: + - date: '2023-03-27T00:00:00' + assets: + name: Assets + value: 260454.26 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 36998.49 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35824.11 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70020.01 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 189399.22 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 129008.09 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71992.44 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 26065.84 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 26065.84 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99721.85 + items: + - name: Current Liabilities + value: 99735.85 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42435.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57906.98 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 160732.41 + equity: + name: Equity + value: 160732.41 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 71020.55 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 262531.32 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 37693.84 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35778.16 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70669.41 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 188021.29 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 127634.34 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71988.26 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 28825.48 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 28825.48 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99680 + items: + - name: Current Liabilities + value: 99694 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42459.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57841.13 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 162851.32 + equity: + name: Equity + value: 162851.32 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 73139.46 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Exact (Netherlands): + value: + reports: [] + Exact (UK): + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00Z' + assets: + name: Assets + value: -2 + items: + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: -3 + items: [] + - accountId: ba382d88-a4e5-4117-8fc6-4752ee8bc93d + name: 15801 - Standard account + value: 1 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: -2 + equity: + name: Equities + value: -2 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -2 + items: [] + - date: '2022-09-30T00:00:00Z' + assets: + name: Assets + value: 208 + items: + - accountId: 885ff551-664d-451b-995b-cb114c9877d0 + name: 15890 - Unallocated Cash + value: 0 + items: [] + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: 78 + items: [] + - accountId: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: 15880 - Bank + value: 130 + items: [] + liabilities: + name: Liabilities + value: 0 + items: + - accountId: 88d733a8-51e1-4ee7-b2a0-fb49879e36cc + name: 21000 - Trade Creditors + value: 0 + items: [] + netAssets: 208 + equity: + name: Equities + value: 208 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: 208 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + FreshBooks: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + KashFlow: + value: + currency: GBP + reports: + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + - date: '2022-08-31T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + mostRecentAvailableMonth: '2022-09-30T00:00:00' + earliestAvailableMonth: '2022-03-01T00:00:00' + MYOB AccountRight and Essentials: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Oracle NetSuite: + value: + currency: GBP + reports: + - date: '2023-05-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + - date: '2023-04-30T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + mostRecentAvailableMonth: '2023-05-31T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: ASSETS + value: 549695.86 + items: + - name: Current Assets + value: 81821.64 + items: + - name: Checking/Savings + value: 57007.53 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 40814.11 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 7719.99 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 7719.99 + items: [] + - name: Other Current Assets + value: 17094.12 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13177.4 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 1350 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 451499.2 + items: + - name: Current Liabilities + value: 6718.02 + items: + - name: Accounts Payable + value: 5000 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5000 + items: [] + - name: Credit Cards + value: 1400 + items: + - accountId: 570000-1071509253 + name: 20500 � QuickBooks Credit Card + value: 1400 + items: [] + - name: Other Current Liabilities + value: 318.02 + items: + - accountId: 100000-933270541 + name: 25500 � Sales Tax Payable + value: 318.02 + items: [] + - name: Long Term Liabilities + value: 444781.18 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 19932.64 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 50644.52 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 98196.66 + equity: + name: Equity + value: 98196.66 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 22708.94 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: ASSETS + value: 547971.05 + items: + - name: Current Assets + value: 80096.83 + items: + - name: Checking/Savings + value: 45769.39 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 29575.97 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 16228.47 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 16228.47 + items: [] + - name: Other Current Assets + value: 18098.97 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13507.25 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 2025 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 453300.75 + items: + - name: Current Liabilities + value: 5714 + items: + - name: Accounts Payable + value: 5714 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5714 + items: [] + - name: Long Term Liabilities + value: 447586.75 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 20376.27 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 53006.46 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 94670.3 + equity: + name: Equity + value: 94670.3 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 19182.58 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online Sandbox: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: Assets + value: 3856584.88 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 520021.91 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 17546.08 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -15900.6 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 211127.4 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109500.4 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128050.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -29.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: 2655 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24513.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3074459.19 + items: + - accountId: '70' + name: Debtors + value: 3041138.07 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -7.45 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259337.61 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36524 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220930.75 + items: [] + liabilities: + name: Liabilities + value: 169469.71 + items: + - name: Accounts Payable + value: 93748.74 + items: + - accountId: '71' + name: Creditors + value: 93635.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 10841.34 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 9957.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2469.91 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3425.44 + items: [] + - name: Other Current Liability + value: 10001.33 + items: + - accountId: '118' + name: Current Liabilities + value: 82.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -4738.49 + items: [] + - accountId: '54' + name: VAT Suspense + value: 5390 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3687115.17 + equity: + name: Equity + value: 3687115.17 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -10470.26 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 4385453.25 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 1048102.14 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 14029.28 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -11410.5 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 741293.8 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109155.93 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128055.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -14.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: -5 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24438.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3075173.68 + items: + - accountId: '70' + name: Debtors + value: 3041854.11 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -9 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259411.26 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36533.45 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220994.95 + items: [] + liabilities: + name: Liabilities + value: 699368.94 + items: + - name: Accounts Payable + value: 93773.74 + items: + - accountId: '71' + name: Creditors + value: 93660.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 12226.79 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 11004.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2471.46 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3765.44 + items: [] + - name: Other Current Liability + value: 538490.11 + items: + - accountId: '118' + name: Current Liabilities + value: 72.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -3792.71 + items: [] + - accountId: '54' + name: VAT Suspense + value: 532943 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3686084.31 + equity: + name: Equity + value: 3686084.31 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -11501.12 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online: + value: + reports: [] + Sage 50 (UK): + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 1740591.73 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1425254.88 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.71 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: bb6151d3fd744fa6a81f2164b1d156dc + name: 13918348 - PUSH 1 Matt Ager Test EUR Account + value: 9 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 173084617.49 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 183778965.2 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57234.67 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199200.59 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10893226.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -171344025.76 + equity: + name: Equities + value: -171344025.76 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -171344025.76 + items: [] + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 1748139.93 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1432812.05 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.74 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 161482418.52 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 171440565.23 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57232.9 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199003.36 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10156826.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -159734278.59 + equity: + name: Equities + value: -159734278.59 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -159734278.59 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + Wave: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 2220.87 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 219 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4641.15 + items: + - name: Current Liabilities + value: 4641.15 + items: + - name: Accounts Payable + value: 3557.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -2420.28 + equity: + name: Equity + value: -2420.28 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -2484.08 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Nov 30, 2022' + value: -533.49 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 2222.22 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 220.35 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4086.15 + items: + - name: Current Liabilities + value: 4086.15 + items: + - name: Accounts Payable + value: 3002.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -1863.93 + equity: + name: Equity + value: -1863.93 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -1927.73 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Oct 31, 2022' + value: 22.86 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Xero: + value: + currency: GBP + reports: + - date: '2023-03-31T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + - date: '2023-02-28T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Zoho Books: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + - date: '2022-09-01T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/profitAndLoss': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get profit and loss + description: Gets the latest profit and loss for a company. + operationId: get-accounting-profit-and-loss + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingProfitAndLossReport' + examples: + Clear Books: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + accountId: '' + name: Income + value: 146840.42 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 146840.42 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 29955.45 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 29955.45 + items: [] + grossProfit: 116884.97 + expenses: + accountId: '' + name: Expenses + value: 62407.18 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 24962.87 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 1550.12 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 1410.61 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 1283.66 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 1168.13 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 944.89 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 977.96 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 889.94 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 719.86 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 6000.46 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 609.29 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 630.62 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 510.1 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 527.95 + items: [] + netOperatingProfit: 54477.79 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 54977.57 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + accountId: '' + name: Income + value: 108461.81 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 108461.81 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 18438.51 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 18438.51 + items: [] + grossProfit: 90023.3 + expenses: + accountId: '' + name: Expenses + value: 46096.28 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 18438.51 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 669.33 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 609.09 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 554.28 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 448.35 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 412.48 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 426.92 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 388.49 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 314.25 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 325.25 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 2600.97 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 239.41 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 220.26 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 227.97 + items: [] + netOperatingProfit: 43927.02 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 44426.8 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 658.5 + items: + - name: Sales Returns & Allowances + value: 0 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: 0 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: 0 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: 0 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: 0 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: 0 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 658.5 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 658.5 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 0 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 2735.64 + items: + - name: Materials + value: 2735.64 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 2735.64 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: -2077.14 + expenses: + name: Expense + value: 41.77 + items: + - name: '' + value: 0 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 0 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: 0 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: 0 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 41.77 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 41.77 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -2118.91 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2118.91 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 414.51 + items: + - name: Sales Returns & Allowances + value: -125.17 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: -125.17 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: -10 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: -10 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: -12.91 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: -12.91 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 430.4 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 430.4 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 132.19 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 132.19 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 328 + items: + - name: Materials + value: 328 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 328 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: 86.51 + expenses: + name: Expense + value: 1482.02 + items: + - name: '' + value: 9.52 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 9.52 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: -1.82 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: -1.82 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 1474.32 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 1474.32 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -1395.51 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -1395.51 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Exact (Netherlands): + value: + reports: + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: -286 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: -286 + items: [] + - accountId: 0b5b5d8b-1c0c-4767-88d8-c99206da6ace + name: 555777 - Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -286 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -286 + otherExpenses: + name: Other Expenses + value: 5.25 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 5.25 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -5.25 + netProfit: -291.25 + - fromDate: '2022-08-01T00:00:00Z' + toDate: '2022-08-31T00:00:00Z' + income: + name: Income + value: 664.73 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: 643.33 + items: [] + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: -13.6 + items: [] + - accountId: f93008c5-f45b-4200-82a8-d0d5e1584ee7 + name: 1234567 - james_test2 + value: 35 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 664.73 + expenses: + name: Expenses + value: 13.6 + items: + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: 13.6 + items: [] + netOperatingProfit: 651.13 + otherExpenses: + name: Other Expenses + value: 45 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 45 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -45 + netProfit: 606.13 + reportBasis: Unknown + currency: EUR + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Exact (UK): + value: + reports: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + income: + name: Income + value: -2 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: -2 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -2 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -2 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2 + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: 208 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: 208 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 208 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 208 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 208 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 24.05 + items: + - accountId: '3384197' + name: Advertising + value: 0.21 + items: [] + - accountId: '3380421' + name: Car & Truck Expenses + value: 11 + items: [] + - accountId: '3361426' + name: Meals & Entertainment + value: 12.82 + items: [] + - accountId: '3379249' + name: Supplies + value: 0.02 + items: [] + netOperatingProfit: -24.05 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -24.04 + reportBasis: Cash + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + KashFlow: + value: + reports: + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-08-01T00:00:00' + toDate: '2022-08-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-10-01T00:00:00' + MYOB AccountRight and Essentials: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Oracle NetSuite: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: -123.45 + items: + - accountId: '58' + name: Expenses + value: -123.45 + items: [] + netOperatingProfit: 123.45 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 123.45 + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 11 + items: + - accountId: '108' + name: Shipping and Handling + value: 11 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 11 + expenses: + name: Expenses + value: 11 + items: + - accountId: '58' + name: Expenses + value: 11 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 7673.5 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 7673.5 + items: + - accountId: 190000-933270541 + name: 40130 � Labor Income + value: 840 + items: [] + - accountId: 1A0000-933270542 + name: 40140 � Materials Income + value: 4103.5 + items: [] + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 2730 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 1729.85 + items: + - accountId: 1E0000-933270542 + name: 50100 � Cost of Goods Sold + value: 329.85 + items: [] + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 1400 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 1400 + items: [] + grossProfit: 5943.65 + expenses: + name: Expense + value: 2417.29 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 1066.56 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 162 + items: [] + - accountId: 580000-1071498064 + name: 60120 � Insurance + value: 712.56 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 192 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 438.3 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 438.3 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 224.93 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 120.93 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 3526.36 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 3526.36 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 16500 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 16500 + items: + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 16500 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 7500 + items: + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 7500 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 7500 + items: [] + grossProfit: 9000 + expenses: + name: Expense + value: 3159.99 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 359 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 127 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 232 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 456.29 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 456.29 + items: [] + - accountId: 3D0000-933270542 + name: 64200 � Repairs + value: 1164 + items: + - accountId: 3F0000-933270542 + name: 64220 � Computer Repairs + value: 714 + items: [] + - accountId: 400000-933270542 + name: 64230 � Equipment Repairs + value: 450 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 493.2 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 389.2 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 5840.01 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 93.42 + items: + - accountId: 4C0000-933270542 + name: 70200 � Interest Income + value: 93.42 + items: [] + netOtherIncome: 93.42 + netProfit: 5933.43 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 35.7 + items: + - accountId: '68' + name: Billable Expenses Income + value: -15 + items: [] + - accountId: '44' + name: Sales + value: 130 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 42.5 + items: [] + - accountId: '1' + name: Services + value: -131.8 + items: [] + - accountId: '149' + name: Shipping Income + value: 10 + items: [] + costOfSales: + name: Cost of Sales + value: -8.16 + items: + - accountId: '67' + name: Cost of sales + value: 33.51 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: -41.67 + items: [] + grossProfit: 43.86 + expenses: + name: Expenses + value: -987 + items: + - accountId: '148' + name: Billable Test + value: -250 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: -897 + items: [] + - accountId: '18' + name: Depreciation Expense + value: 100 + items: [] + - accountId: '19' + name: Dues and Subscriptions + value: -40 + items: [] + - accountId: '64' + name: Purchases + value: 100 + items: [] + netOperatingProfit: 1030.86 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 1030.86 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 1664.93 + items: + - accountId: '14' + name: Commission Income + value: 64 + items: [] + - accountId: '44' + name: Sales + value: 952.29 + items: [] + - accountId: '43' + name: Sales Discounts + value: 9.05 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 223.52 + items: [] + - accountId: '1' + name: Services + value: 392.32 + items: [] + - accountId: '149' + name: Shipping Income + value: 23.75 + items: [] + costOfSales: + name: Cost of Sales + value: 2568.09 + items: + - accountId: '67' + name: Cost of sales + value: 27.09 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: 41 + items: [] + - accountId: '10' + name: Entertainment Booking Fees paid on behalf of clients + value: 2500 + items: [] + grossProfit: -903.16 + expenses: + name: Expenses + value: 397.62 + items: + - accountId: '148' + name: Billable Test + value: -35.75 + items: [] + - accountId: '12' + name: Business Licenses and Permits + value: -8 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: 42.46 + items: [] + - accountId: '20' + name: Equipment rental + value: -22.76 + items: [] + - accountId: '116' + name: HM Revenue & Customs (VAT) Expense + value: -25.2 + items: [] + - accountId: '24' + name: Insurance Expense + value: 5.32 + items: [] + - accountId: '23' + name: Insurance Expense-Health Insurance + value: -34 + items: [] + - accountId: '31' + name: Marketing Expense + value: -11.56 + items: [] + - accountId: '35' + name: Office Supplies + value: -12.89 + items: [] + - accountId: '64' + name: Purchases + value: 500 + items: [] + netOperatingProfit: -1300.78 + otherExpenses: + name: Other Expenses + value: 11.92 + items: + - accountId: '52' + name: Exchange Gain or Loss + value: 11.92 + items: [] + otherIncome: + name: Other Income + value: 29.41 + items: + - accountId: '21' + name: Finance Charge Income + value: -13.44 + items: [] + - accountId: '27' + name: Insurance Proceeds Received + value: 7.85 + items: [] + - accountId: '29' + name: Interest income + value: 15 + items: [] + - accountId: '39' + name: Proceeds from Sale of Assets + value: 20 + items: [] + netOtherIncome: 17.49 + netProfit: -1283.29 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 4300 + items: + - accountId: '68' + name: 303 HM Revenue & Customs (VAT) Expense + value: 250 + items: [] + - accountId: '22' + name: 408 Travelling expenses + value: 4050 + items: [] + netOperatingProfit: -4300 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -4300 + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 10 + items: + - accountId: '16' + name: 292 Advertising + value: 10 + items: [] + netOperatingProfit: -10 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -10 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-01-01T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Sage 200cloud: + value: + reports: + - fromDate: '2020-12-01T00:00:00Z' + toDate: '2020-12-31T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2020-11-01T00:00:00Z' + toDate: '2020-11-30T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2020-12-01T00:00:00' + earliestAvailableMonth: '2015-01-01T00:00:00' + Sage 50 (UK): + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: -7749 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: -7740 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -9 + items: [] + costOfSales: + name: Cost of Sales + value: 11602000 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 11602000 + items: [] + grossProfit: -11609749 + expenses: + name: Expenses + value: -1.83 + items: + - accountId: 9a99a91c267a11e797950a57719b2edb + name: 8211 - Exchange rate gain/(loss) + value: -1.83 + items: [] + netOperatingProfit: -11609747.17 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -11609747.17 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 501 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: 511 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -10 + items: [] + costOfSales: + name: Cost of Sales + value: 13220073.7 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 13220073.7 + items: [] + grossProfit: -13219572.7 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -13219572.7 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: -148.34 + items: + - accountId: 9a995491267a11e797950a57719b2edb + name: 4900 - Other income + value: -148.34 + items: [] + netOtherIncome: -148.34 + netProfit: -13219721.04 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Wave: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 7.01 + items: + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 7.01 + expenses: + name: Operating Expenses + value: 555 + items: + - name: Office Supplies + value: 555 + items: [] + netOperatingProfit: -547.99 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -547.99 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 8.36 + items: + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 8.36 + expenses: + name: Operating Expenses + value: 0 + items: [] + netOperatingProfit: 8.36 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 8.36 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 14496.51 + items: + - accountId: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + value: 14496.51 + items: [] + costOfSales: + name: Cost of Sales + value: 700 + items: + - accountId: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b + name: Purchases + value: 700 + items: [] + grossProfit: 13796.51 + expenses: + name: Expenses + value: 2026.92 + items: + - accountId: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + value: 215.87 + items: [] + - accountId: d50842c3-af67-4233-b8c9-df3180f5b7bd + name: 'Light, Power, Heating' + value: 103.43 + items: [] + - accountId: 0be1631e-cc7e-4c27-951f-308c3307c0fe + name: Motor Vehicle Expenses + value: 342.79 + items: [] + - accountId: a49cc958-968e-4b54-96d6-8853c036009e + name: 'Postage, Freight & Courier' + value: 94.19 + items: [] + - accountId: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + value: 24.58 + items: [] + - accountId: dae8e236-24bb-4a7a-9787-c5fd89385e03 + name: Rent + value: 984.38 + items: [] + - accountId: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + value: 14.9 + items: [] + - accountId: f3c73c3d-9887-4377-b18b-0374ab62e4aa + name: Telephone & Internet + value: 45.11 + items: [] + - accountId: c7b73345-7f25-428a-bb97-7b20a1470a53 + name: Travel - National + value: 201.67 + items: [] + netOperatingProfit: 11769.59 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 11769.59 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Operating Income + value: 0 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 0 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Operating Expense + value: 0 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 0 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Operating Income + value: 69 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 69 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 35 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 35 + items: [] + grossProfit: 34 + expenses: + name: Operating Expense + value: 69 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 69 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: -35 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -35 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/cashFlowStatement': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get cash flow statement + description: Gets the latest cash flow statement for a company. + operationId: get-accounting-cash-flow-statement + x-speakeasy-group: financial-statements.cash-flow + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCashFlowStatement' + examples: + Clear Books: + value: + reports: + - fromDate: '2021-02-01T00:00:00' + toDate: '2021-02-28T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 18377.72 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 11417.63 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 6960.09 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 12377.81 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 7479.21 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 700 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 4198.6 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + - fromDate: '2021-01-01T00:00:00' + toDate: '2021-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 14508.56 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 3055.53 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 11453.03 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 18902.85 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 9673.66 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 1250 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 7979.19 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2021-02-28T00:00:00' + earliestAvailableMonth: '2019-03-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + reportBasis: Cash + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 754.59 + items: + - accountId: income + name: Income + value: 729.59 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 25 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: -987.94 + items: + - accountId: costOfSales + name: Cost of Sales + value: 24.06 + items: [] + - accountId: expenses + name: Expenses + value: -1012 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 1776.25 + items: + - accountId: income + name: Income + value: 1652.12 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 124.13 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 2494.43 + items: + - accountId: costOfSales + name: Cost of Sales + value: 2562 + items: [] + - accountId: accountsPayable + name: Accounts Payable + value: 38.02 + items: [] + - accountId: expenses + name: Expenses + value: -105.59 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 4300 + items: + - accountId: expenses + name: Expenses + value: 4300 + items: [] + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 10 + items: + - accountId: expenses + name: Expenses + value: 10 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-01-31T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: 0 + items: + - accountId: income + name: Net Income + value: 0 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 0 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 0 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: -5 + items: + - accountId: income + name: Net Income + value: -35 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 30 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 7 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 7 + items: [] + reportBasis: Accrual + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2019-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accountBalances': + get: + tags: + - Bank statements + summary: List account balances + operationId: list-banking-account-balances + x-speakeasy-group: banking.account-balances + description: |- + The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection. + + [Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccountBalances' + examples: + Basiq: + value: + results: + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 11389.85 + date: '2017-12-31T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 8002.09 + date: '2018-01-01T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3103 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=2&pageSize=2 + Plaid: + value: + results: + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-13T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-14T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts': + get: + tags: + - Bank statements + summary: List accounts + operationId: list-banking-accounts + x-speakeasy-group: banking.accounts + description: |- + The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccounts' + examples: + Basiq: + value: + results: + - id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + - id: 736d90a5-f836-4ae0-a161-1e8056f39701 + name: Standard Variable Rate Home Loan + holder: david smith + type: Credit + balance: + available: 6940.31 + current: 6940.31 + identifiers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Standard Variable Rate Home Loan + accountHolder: david smith + accountType: Credit + accountNumbers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=2&pageSize=2 + Plaid: + value: + results: + - id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}': + get: + tags: + - Bank statements + summary: Get account + operationId: get-banking-account + x-speakeasy-group: banking.accounts + description: |- + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccount' + examples: + Basiq: + value: + id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + Plaid: + value: + id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transactions + x-speakeasy-group: banking.transactions + summary: List transactions + description: |- + The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/BankingTransactions' + examples: + Basiq: + value: + results: + - id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + - id: 0023c431-35c8-41f5-b75e-9239413cde7e + accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + description: Transfer from xx9263 CommBank app Shop + amount: 191 + currency: AUD + postedDate: '2018-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: transfer + name: Transfer + modifiedDate: '2022-10-28T07:15:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3319 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=2&pageSize=2 + Plaid: + value: + results: + - id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + - id: 1514wvMMajumgG7xWA1Bt8oDLxlpm3i3zraD7_6DB63D1DACF6F5824C80F8BE2E066DB5 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2022-10-02T00:00:00' + authorizedDate: '2022-10-01T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 49 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionId + in: path + required: true + description: The unique identifier for a transaction + get: + summary: Get bank transaction + tags: + - Bank statements + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransaction' + examples: + Basiq: + value: + id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + Plaid: + value: + id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-banking-transaction + x-speakeasy-group: banking.transactions + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transaction-categories + x-speakeasy-group: banking.transaction-categories + summary: List transaction categories + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategories' + examples: + Basiq: + value: + results: + - id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + - id: cash-withdrawal + name: Cash Withdrawal + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=2&pageSize=2 + Plaid: + value: + results: + - id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + - id: BANK_FEES.BANK_FEES_ATM_FEES + name: BANK_FEES_ATM_FEES + parentId: BANK_FEES + hasChildren: false + status: Active + modifiedDate: '2022-10-27T10:50:17' + pageNumber: 1 + pageSize: 2 + totalResults: 120 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection. + + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionCategoryId + in: path + required: true + description: The unique identifier for a banking transaction category + get: + tags: + - Bank statements + operationId: get-banking-transaction-category + x-speakeasy-group: banking.transaction-categories + summary: Get transaction category + description: | + The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. + + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategory' + examples: + Basiq: + value: + id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + Plaid: + value: + id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Sales + summary: List customers + operationId: list-commerce-customers + x-speakeasy-group: sales.customers + description: |- + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCustomers' + examples: + BigCommerce: + value: + results: + - id: '1' + customerName: Amy Jones + emailAddress: a.jackson@email.me + defaultCurrency: XXX + phone: 07770 666777 + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + - id: '2' + customerName: Cust001 Cust001 + emailAddress: Cust001@example.com + defaultCurrency: XXX + phone: 05442 203941 + addresses: [] + createdDate: '2023-04-11T15:49:25Z' + modifiedDate: '2023-04-17T15:42:55Z' + sourceModifiedDate: '2023-04-11T15:49:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 201 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=2&pageSize=2 + Clover: + value: + results: + - id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: 511JV0FRN2QYC + customerName: '' + addresses: [] + createdDate: '2021-09-21T14:54:38Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=2&pageSize=2 + Mollie: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + - id: '3' + customerName: Fake Name + emailAddress: bob@bob.com + addresses: [] + createdDate: '2021-09-03T01:55:13' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-03T01:55:13' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=2&pageSize=2 + Shopify: + value: + results: + - id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + - id: '5097398534302' + customerName: Qa Test + phone: '+445593368390' + addresses: + - type: Unknown + line1: Look Street + city: London + postalCode: PO16 7GZ + - type: Unknown + line1: Look Street + city: London + region: England + country: United Kingdom + postalCode: PO16 7GZ + note: '' + createdDate: '2021-03-19T10:12:37' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:07:59' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=2&pageSize=2 + Square: + value: + results: + - id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + - id: GXQDPSZSMN6C58270SZN4YJZ8R + emailAddress: s.shandil+square@codat.io + phone: '+447729946295' + addresses: [] + createdDate: '2020-11-19T14:56:00Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-11-19T14:56:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers + Stripe Test: + value: + results: + - id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: cus_LXdFFgHqqVURIv + customerName: David Dunlow + emailAddress: david@example.com + defaultCurrency: gbp + phone: '+447545309714' + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + - type: Delivery + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + note: Test Subscriptions + createdDate: '2022-04-20T07:30:01Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers + Zettle: + value: + results: + - id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + - id: joe@bloggs.com + customerName: Joe Bloggs + emailAddress: joe@bloggs.com + phone: 02012 345678 + addresses: + - type: Unknown + line1: Flat 1 + line2: 1 High Street + city: London + region: London + country: GB + - type: Unknown + line1: Flat 2 + line2: 2 High Street + city: London + region: London + country: GB + createdDate: '2020-12-21T14:52:15' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2020-12-21T14:52:15' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Sales + summary: Get customer + operationId: get-commerce-customer + x-speakeasy-group: sales.customers + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCustomer' + examples: + BigCommerce: + value: + id: '1' + customerName: Amy Jones + emailAddress: a.durbanjackson+amy@codat.io + defaultCurrency: XXX + phone: '07770666777' + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + Clover: + value: + id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Mollie: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + PrestaShop: + value: + id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + Shopify: + value: + id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + Square: + value: + id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + Stripe Test: + value: + id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + WooCommerce: + value: + id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + Zettle: + value: + id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List disputes + tags: + - Sales + operationId: list-commerce-disputes + x-speakeasy-group: sales.disputes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceDisputes' + examples: + Shopify: + value: + results: + - id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + - id: '8502444190' + disputedTransactions: + - id: '3684119445662' + type: Order + totalAmount: 600 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:18:31' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:18' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes + Stripe Test: + value: + results: + - id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: dp_1HqiwVA8m8S1Gh7OpS3ozlcd + disputedTransactions: + - id: txn_1HqiwVA8m8S1Gh7O0IVelTQ5 + type: Payment + totalAmount: 55 + currency: GBP + status: Lost + reason: product_not_received + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T17:35:11Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection. + + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: disputeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a dispute. + get: + summary: Get dispute + tags: + - Sales + operationId: get-commerce-dispute + x-speakeasy-group: sales.disputes + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceDispute' + examples: + Shopify: + value: + id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + Stripe Test: + value: + id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get dispute* endpoint returns a single dispute for a given disputeId. + + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-info': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get company commerce profile + tags: + - Company info + operationId: get-commerce-profile + x-speakeasy-name-override: get-commerce-profile + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + baseCurrency: GBP + accountBalances: + - available: 20053.23 + pending: 2034.23 + reserved: 517.23 + currency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2019-03-07T16:50:49' + modifiedDate: '2022-03-10T15:42:13' + sourceModifiedDate: '2021-06-10T01:48:49' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Retrieve information about the company, as seen in the commerce + platform. + + This may include information like addresses, tax registration details and + social media or website information." + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List locations + tags: + - Sales + operationId: list-commerce-locations + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocations' + examples: + Clover: + value: + results: + - id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations + Lightspeed K Trial: + value: + results: + - id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations + Shopify: + value: + results: + - id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations + Square: + value: + results: + - id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection. + + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: locationId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a location. + get: + summary: Get location + tags: + - Sales + operationId: get-commerce-location + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocation' + examples: + Clover: + value: + id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + Lightspeed K Trial: + value: + id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + Shopify: + value: + id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + Square: + value: + id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get location* endpoint returns a single location for a given locationId. + + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List orders + tags: + - Sales + operationId: list-commerce-orders + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrders' + examples: + Amazon Seller Central: + value: + results: + - id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders + BigCommerce: + value: + results: + - id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + - id: '101' + orderNumber: '101' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:49:02Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '3' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '4' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:49:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=2&pageSize=2 + Clover: + value: + results: + - id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + - id: 0G22TXMYQQE54 + orderNumber: 0G22TXMYQQE54 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T11:24:48Z' + totalAmount: 1340 + totalRefund: 0 + totalTaxAmount: 240 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: GZ73TPFAV6NTP + quantity: 1 + taxPercentage: 20 + totalAmount: 1440 + totalTaxAmount: 240 + unitPrice: 1200 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 240 + productRef: + id: QVAV6KM1457B0 + name: Desktop + discountAllocations: [] + - id: 'Discount: �10 off' + quantity: 1 + taxPercentage: 0 + totalAmount: -100 + totalTaxAmount: 0 + unitPrice: 0 + taxes: [] + discountAllocations: + - name: �10 off + totalAmount: 100 + payments: + - id: H726AAJQYE3SP + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T11:24:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 76 + _links: + current: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders + next: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + - id: A61465.2 + orderNumber: A61465.2 + country: 'AU ' + currency: AUD + createdDate: '2022-12-12T23:20:12Z' + closedDate: '2022-12-12T23:21:29Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 0.91 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.2 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.46 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.46 + productRef: + id: '647208621834663' + name: Royal + discountAllocations: [] + - id: S61465.3 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834623' + name: Mocha + discountAllocations: [] + payments: + - id: 'R61465.2_1_A61465.2_2022-12-12T23:21:29.006Z' + amount: 10 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-12T23:21:29' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=2&pageSize=2 + Mollie: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders + Mollie Test: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders + Partner Commerce: + value: + results: + - id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders + PrestaShop: + value: + results: + - id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + - id: '10' + orderNumber: UFQZXPGQU + country: 'US ' + currency: USD + createdDate: '2021-09-28T08:09:46' + totalAmount: 19.12 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 4.78 + totalGratuity: 0 + orderLineItems: + - id: '14' + quantity: 1 + taxPercentage: 0 + totalAmount: 19.12 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: + - name: 20% Discount + totalAmount: 4.78 + payments: [] + serviceCharges: [] + customerRef: + id: '5' + name: Tobi Yinusa + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-28T08:09:46' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=2&pageSize=2 + Shopify: + value: + results: + - id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + - id: '3684180361374' + orderNumber: '1011' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:57:30' + totalAmount: 105 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670570901662' + quantity: 3 + taxPercentage: 0 + totalAmount: 105 + totalTaxAmount: 0 + unitPrice: 35 + taxes: [] + productRef: + id: '6595497787550' + name: Keyboard + productVariantRef: + id: '39444537213086' + name: Keyboard + discountAllocations: [] + payments: + - id: '4630311108766' + amount: 105 + currency: GBP + type: Unknown + status: Paid + paymentProvider: Manual + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:57:30' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:57:30' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=2&pageSize=2 + Square: + value: + results: + - id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + orderNumber: TNEU7333HZ + country: XXX + currency: GBP + createdDate: '2021-03-26T21:09:59Z' + totalAmount: 15 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Sale of some product + quantity: 1 + taxPercentage: 0 + totalAmount: 15 + totalTaxAmount: 0 + unitPrice: 15 + taxes: [] + discountAllocations: [] + payments: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + - id: '145' + orderNumber: '145' + country: 'GB ' + currency: GBP + createdDate: '2021-09-24T12:15:29Z' + totalAmount: 27.5 + totalRefund: 0 + totalTaxAmount: 5.5 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '59' + quantity: 2 + taxPercentage: 25 + totalAmount: 27.5 + totalTaxAmount: 5.5 + unitPrice: 11 + taxes: [] + productRef: + id: '87' + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2022-03-24T16:01:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 25 + _links: + current: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders + next: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=2&pageSize=2 + Zettle: + value: + results: + - id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + - id: CV5TJC2YEeueVK3fSQEQIw + orderNumber: '4' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:28:05Z' + totalAmount: 25 + totalRefund: 0 + totalTaxAmount: 1.19 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 5 + totalAmount: 25 + totalTaxAmount: 1.19 + unitPrice: 23.81 + taxes: [] + productRef: + id: 89570bee-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 89570c52-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:28:05Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection. + + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: orderId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an order. + get: + summary: Get order + tags: + - Sales + operationId: get-commerce-order + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrder' + examples: + Amazon Seller Central: + value: + id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + BigCommerce: + value: + id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + Clover: + value: + id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + Lightspeed K Trial: + value: + id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + Mollie: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + Partner Commerce: + value: + id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + PrestaShop: + value: + id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + Shopify: + value: + id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + Square: + value: + id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + WooCommerce: + value: + id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + Zettle: + value: + id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get order* endpoint returns a single order for a given orderId. + + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payment methods + tags: + - Sales + operationId: list-commerce-payment-methods + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethods' + examples: + Amazon Seller Central: + value: + results: + - id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + - id: GC + name: Gift Card + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + - id: bigcommerce_store_credit + name: Store Credit + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods + Clover: + value: + results: + - id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + - id: 24H1ANYP1BNXG + name: MyTab + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + - id: '647208621834261' + name: Credit Card + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods + next: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=2&pageSize=2 + Square: + value: + results: + - id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + - id: BUY_NOW_PAY_LATER + name: Buy Now Pay Later + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods + next: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=2&pageSize=2 + SumUp: + value: + results: + - id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + - id: CC_CUSTOMER_ENTERED + name: Credit Card + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection. + + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: paymentMethodId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment method. + get: + summary: Get payment method + tags: + - Sales + operationId: get-commerce-payment-method + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethod' + examples: + Amazon Seller Central: + value: + id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + BigCommerce: + value: + id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + Clover: + value: + id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + Lightspeed K Trial: + value: + id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + Mollie: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + Mollie Test: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + Square: + value: + id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + SumUp: + value: + id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. + + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payments + tags: + - Sales + operationId: list-commerce-payments + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayments' + examples: + BigCommerce: + value: + results: + - id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + - id: 105_2_2_refund + amount: -33.95 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-24T13:57:01Z' + modifiedDate: '2023-04-11T10:33:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=2&pageSize=2 + Clover: + value: + results: + - id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + - id: 0A8ZMPG40Q9AM + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:31Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:31Z' + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + paymentMethodRef: + id: '647208621834714' + name: LSPay - Mary + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46Z' + modifiedDate: '2023-03-02T09:50:43Z' + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=2&pageSize=2 + Mollie: + value: + results: + - id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + - id: re_NPKEJhQveu + amount: -60 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T16:15:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments + next: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + - id: '2' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:53:28' + modifiedDate: '2022-01-26T15:09:42Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=2&pageSize=2 + Shopify: + value: + results: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:18:29Z' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=2&pageSize=2 + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + amount: 15 + currency: GBP + type: Cash + status: Paid + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-03-17T16:13:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments + next: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + - id: '35' + amount: 30 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:08:56Z' + modifiedDate: '2021-07-13T16:19:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=2&pageSize=2 + Zettle: + value: + results: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + - id: 226580d6-2d98-11eb-a35c-fed5e63de507 + amount: 58.5 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:47Z' + modifiedDate: '2021-10-27T15:22:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/paymentId' + get: + summary: Get payment + tags: + - Sales + operationId: get-commerce-payment + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayment' + examples: + BigCommerce: + value: + id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + Clover: + value: + id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + Lightspeed K Trial: + value: + id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + Mollie: + value: + id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + PrestaShop: + value: + id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + Shopify: + value: + id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + WooCommerce: + value: + id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + Zettle: + value: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List product categories + tags: + - Sales + operationId: list-commerce-product-categories + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategories' + examples: + Lightspeed K Trial: + value: + results: + - id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + - id: '647208621834282' + name: NA beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection. + + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product category + tags: + - Sales + operationId: get-commerce-product-category + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategory' + examples: + Lightspeed K Trial: + value: + id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-products': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List products + tags: + - Sales + operationId: list-commerce-products + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProducts' + examples: + Amazon Seller Central: + value: + results: + - id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + - id: vb554a-bl1915 + categorization: COAT + name: Waterproof Jacket + description: 'Wind and rainproof, keeping you dry all year round.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: 'ARRIS,SB6141' + name: Waterproof Jacket (Black) + quantity: 0 + isTaxEnabled: false + sku: 'ARRIS,SB6141' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: RTN66U-N9000 + name: Waterproof Jacket (Blue) + quantity: 0 + isTaxEnabled: false + sku: RTN66U-N9000 + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: TLWR841N + name: Waterproof Jacket (Red) + quantity: 0 + isTaxEnabled: false + sku: TLWR841N + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + - id: '104' + categorization: 'Shop All, Utility' + name: '[Sample] Utility Caddy' + description: 'This powder coated steel utility caddy ensures your cleaning essentials are stowed away in one spot ready for your household chores. Brushes, cloths, liquid soaps can all easily be stashed away. Also ideal to be used as a garden caddy to easily grab from the shed for a days work. Works well as a mop bucket too. The wood carrying handle ensures a comfortable grip when toting it from room to room. Measures 19 h x 36 w x 20 dia cm/7.5 h x 14.1 w x 7.8 dia in' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '72' + name: '[Sample] Utility Caddy' + quantity: 0 + isTaxEnabled: false + sku: OFSUC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 45.95 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:49:26Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2015-07-03T20:45:54Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=2&pageSize=2 + Clover: + value: + results: + - id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + - id: NMZHKK6FKF6ZJ + name: Laptop + description: Cool Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: NMZHKK6FKF6ZJ + name: Laptop + quantity: 0 + isTaxEnabled: true + sku: '111' + barcode: '123' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 1000 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T08:19:14Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + - id: '647208621834542' + categorization: NA beverages + name: NA beverages + description: NA beverages + productCategoryRefs: + - id: '647208621834282' + name: NA beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + - id: '10' + categorization: Home - Accessories - Home Accessories + name: Brown bear cushion + description: 'The brown bear cushion will add a graphic and colorful touch to your sofa, armchair or bed. Create a modern and zen atmosphere that inspires relaxation. Cover 100% cotton, machine washable at 60� / Filling 100% hypoallergenic polyester.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '24' + name: Brown bear cushion (Color = White) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '25' + name: Brown bear cushion (Color = Black) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 22 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=2&pageSize=2 + Shopify: + value: + results: + - id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + - id: '6595497066654' + categorization: Logitech + name: Mouse + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444533706910' + name: Mouse + quantity: 0 + isTaxEnabled: false + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 25 + inventory: + totalQuantity: 71 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:14:01Z' + createdDate: '2021-03-19T10:14:01Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=2&pageSize=2 + Square: + value: + results: + - id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + - id: FYRIQNFTFRGQNQZGZG66MJWI + categorization: Furniture + name: Desk + productCategoryRefs: [] + isGiftCard: false + variants: + - id: VMKSQEABA3WIYGXNAV63JOTZ + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 70 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:45Z' + createdDate: '2021-02-18T15:47:45Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:45Z' + status: Unknown + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products + next: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + - id: prod_IQ6G1MDsvUb87Y + name: Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1HpG3tA8m8S1Gh7Oa6bGLvVD + name: Laptop - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 100 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2020-11-19T16:32:45Z' + createdDate: '2020-11-19T16:32:45Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2022-05-12T23:31:33Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + - id: '28' + categorization: Hardware + name: Keyboard + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '28' + name: Keyboard + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T09:02:58' + createdDate: '2021-03-11T09:02:58' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:02:58' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=2&pageSize=2 + Zettle: + value: + results: + - id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + - id: e02c2930-a34a-11eb-b9db-8f5efc0924aa + categorization: Clothing + name: Hoodie + productCategoryRefs: [] + isGiftCard: false + variants: + - id: fa180e40-a34a-11eb-b9db-8f5efc0924aa + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fc412fd0-a34a-11eb-b9db-8f5efc0924aa + name: Extra Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: f8a03b50-a34a-11eb-b9db-8f5efc0924aa + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fac1bbc0-a34a-11eb-b9db-8f5efc0924aa + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:13:26Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:31:58Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection. + + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product + tags: + - Sales + operationId: get-commerce-product + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProduct' + examples: + Amazon Seller Central: + value: + id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + BigCommerce: + value: + id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + Clover: + value: + id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + Lightspeed K Trial: + value: + id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + PrestaShop: + value: + id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + Shopify: + value: + id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + Square: + value: + id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + Stripe Test: + value: + id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + WooCommerce: + value: + id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + Zettle: + value: + id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List transactions + tags: + - Sales + operationId: list-commerce-transactions + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransactions' + examples: + Mollie: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=2&pageSize=2 + Shopify: + value: + results: + - id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + - id: 'ShopifyPayment-1633176289438:Fee' + totalAmount: -4.05 + currency: GBP + type: PaymentFee + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + - id: 'txn_1HpGQUA8m8S1Gh7OR21pB0Yj:Stripe processing fees' + totalAmount: -0.9 + currency: GBP + type: PaymentFee + subType: stripe_fee + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=2&pageSize=2 + SumUp: + value: + results: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + - id: 471914a4-a82f-4fc4-b39b-9986fd706d26 + totalAmount: 215 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-30T12:22:14Z' + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=2&pageSize=2 + Zettle: + value: + results: + - id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + - id: 'PAYMENT:226580d6-2d98-11eb-a35c-fed5e63de507' + totalAmount: 58.5 + currency: GBP + type: Payment + transactionSourceRef: + id: 226580d6-2d98-11eb-a35c-fed5e63de507 + type: Unknown + createdDate: '2020-11-23T14:28:20Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transactionId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transaction. + get: + summary: Get transaction + tags: + - Sales + operationId: get-commerce-transaction + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransaction' + examples: + Mollie: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + Shopify: + value: + id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + Stripe Test: + value: + id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + SumUp: + value: + id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + Zettle: + value: + id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: List all files uploaded by a company + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Files' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFFThe *List files* endpoint returns a list of all files uploaded to Codat by the SMB. " + operationId: list-files + x-speakeasy-name-override: list-uploaded + '/companies/{companyId}/files/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: Download all files for a company + parameters: + - name: date + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: Only download files uploaded on this date. + responses: + '200': + description: Success + content: + application/octet-stream: + x-speakeasy-usage-example: true + schema: + title: Data + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. + operationId: download-files + x-speakeasy-name-override: download + '/companies/{companyId}/connections/{connectionId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - File upload + summary: Upload files for a company + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUpload' + description: |- + The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data. + + Uploaded files must meet the following requirements: + + - Up to 20 files can be uploaded at a time. + - PDF, XLS, XLSX, XLSB, CSV, DOC, DOCX, PPT, PPTX, JPEG, JPG, and PNG files can be uploaded. + - Each file can be up to 10MB in size. + operationId: upload-files + x-speakeasy-name-override: upload + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update bank account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: 'Needs to be of the format ''{No.}-{Name}''' + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Bank Account Posting Group with Nominal Account must exist + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Must have a length between 0 and 20 characters + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: false + validation: + warnings: [] + information: + - field: OverdraftLimit + details: Default value is 0 + required: true + Exact (Netherlands): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must have a length between 0 and 8 characters + information: [] + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account + options: + - value: AED + type: String + displayName: AED + required: false + - value: AMD + type: String + displayName: AMD + required: false + - value: AOA + type: String + displayName: AOA + required: false + - value: ARS + type: String + displayName: ARS + required: false + - value: AUD + type: String + displayName: AUD + required: false + - value: AWG + type: String + displayName: AWG + required: false + - value: AZN + type: String + displayName: AZN + required: false + - value: BBD + type: String + displayName: BBD + required: false + - value: BDT + type: String + displayName: BDT + required: false + - value: BGN + type: String + displayName: BGN + required: false + - value: BRL + type: String + displayName: BRL + required: false + - value: BWP + type: String + displayName: BWP + required: false + - value: CAD + type: String + displayName: CAD + required: false + - value: CHF + type: String + displayName: CHF + required: false + - value: CLP + type: String + displayName: CLP + required: false + - value: CNY + type: String + displayName: CNY + required: false + - value: COP + type: String + displayName: COP + required: false + - value: CRC + type: String + displayName: CRC + required: false + - value: CUC + type: String + displayName: CUC + required: false + - value: CUP + type: String + displayName: CUP + required: false + - value: CZK + type: String + displayName: CZK + required: false + - value: DKK + type: String + displayName: DKK + required: false + - value: DOP + type: String + displayName: DOP + required: false + - value: EGP + type: String + displayName: EGP + required: false + - value: EUR + type: String + displayName: EUR + required: false + - value: FJD + type: String + displayName: FJD + required: false + - value: GBP + type: String + displayName: GBP + required: false + - value: GEL + type: String + displayName: GEL + required: false + - value: GHS + type: String + displayName: GHS + required: false + - value: GTQ + type: String + displayName: GTQ + required: false + - value: GYD + type: String + displayName: GYD + required: false + - value: HKD + type: String + displayName: HKD + required: false + - value: HNL + type: String + displayName: HNL + required: false + - value: HRK + type: String + displayName: HRK + required: false + - value: HUF + type: String + displayName: HUF + required: false + - value: IDR + type: String + displayName: IDR + required: false + - value: ILS + type: String + displayName: ILS + required: false + - value: INR + type: String + displayName: INR + required: false + - value: ISK + type: String + displayName: ISK + required: false + - value: JMD + type: String + displayName: JMD + required: false + - value: JPY + type: String + displayName: JPY + required: false + - value: KES + type: String + displayName: KES + required: false + - value: KRW + type: String + displayName: KRW + required: false + - value: KWD + type: String + displayName: KWD + required: false + - value: KYD + type: String + displayName: KYD + required: false + - value: KZT + type: String + displayName: KZT + required: false + - value: LAK + type: String + displayName: LAK + required: false + - value: LBP + type: String + displayName: LBP + required: false + - value: LKR + type: String + displayName: LKR + required: false + - value: LTL + type: String + displayName: LTL + required: false + - value: LVL + type: String + displayName: LVL + required: false + - value: MAD + type: String + displayName: MAD + required: false + - value: MDL + type: String + displayName: MDL + required: false + - value: MGA + type: String + displayName: MGA + required: false + - value: MUR + type: String + displayName: MUR + required: false + - value: MVR + type: String + displayName: MVR + required: false + - value: MWK + type: String + displayName: MWK + required: false + - value: MXN + type: String + displayName: MXN + required: false + - value: MYR + type: String + displayName: MYR + required: false + - value: MZN + type: String + displayName: MZN + required: false + - value: NAD + type: String + displayName: NAD + required: false + - value: NGN + type: String + displayName: NGN + required: false + - value: NOK + type: String + displayName: NOK + required: false + - value: NPR + type: String + displayName: NPR + required: false + - value: NZD + type: String + displayName: NZD + required: false + - value: OMR + type: String + displayName: OMR + required: false + - value: PEN + type: String + displayName: PEN + required: false + - value: PHP + type: String + displayName: PHP + required: false + - value: PKR + type: String + displayName: PKR + required: false + - value: PLN + type: String + displayName: PLN + required: false + - value: QAR + type: String + displayName: QAR + required: false + - value: RON + type: String + displayName: RON + required: false + - value: RSD + type: String + displayName: RSD + required: false + - value: RUB + type: String + displayName: RUB + required: false + - value: RWF + type: String + displayName: RWF + required: false + - value: SAR + type: String + displayName: SAR + required: false + - value: SCR + type: String + displayName: SCR + required: false + - value: SEK + type: String + displayName: SEK + required: false + - value: SGD + type: String + displayName: SGD + required: false + - value: THB + type: String + displayName: THB + required: false + - value: TND + type: String + displayName: TND + required: false + - value: TRY + type: String + displayName: TRY + required: false + - value: TTD + type: String + displayName: TTD + required: false + - value: TWD + type: String + displayName: TWD + required: false + - value: TZS + type: String + displayName: TZS + required: false + - value: UAH + type: String + displayName: UAH + required: false + - value: UGX + type: String + displayName: UGX + required: false + - value: USD + type: String + displayName: USD + required: false + - value: UYU + type: String + displayName: UYU + required: false + - value: VEF + type: String + displayName: VEF + required: false + - value: VND + type: String + displayName: VND + required: false + - value: VUV + type: String + displayName: VUV + required: false + - value: XAF + type: String + displayName: XAF + required: false + - value: XCD + type: String + displayName: XCD + required: false + - value: XOF + type: String + displayName: XOF + required: false + - value: ZAR + type: String + displayName: ZAR + required: false + - value: ZMK + type: String + displayName: ZMK + required: false + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + validation: + warnings: [] + information: + - field: Balance + details: 'The opening balance, in the account currency' + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: false + required: true + KashFlow: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of the bank account as it appears in Kashflow. + required: true + balance: + type: Number + displayName: Balance + description: 'The opening balance, in the account currency.' + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account. + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: + - field: AccountName + details: Max length of 31 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + accountNumber: + type: String + displayName: Account Number + description: User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. + required: true + currency: + type: String + displayName: Currency + description: Currency of the bank account. + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: Must be provided. + - field: AccountName + details: Should not be longer than 50 characters. + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + - field: Currency + details: Must match the company's base currency. + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Should be a 6 digit number. + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + validation: + warnings: [] + information: + - field: AccountNumber + details: Should not be longer than 25 characters. + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + validation: + warnings: [] + information: + - field: IBan + details: Should be in the international bank account number format. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + required: true + Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountType: + type: String + displayName: Account Type + description: The type of account + required: true + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: true + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: true + availableBalance: + type: Number + displayName: Available Balance + description: The available balance of the bank account + required: true + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: true + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-bankAccounts-model + x-speakeasy-group: loan-writeback.bank-accounts + description: "The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create bank account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/lending-api#/operations/get-create-update-bankAccounts-model)." + operationId: create-bank-account + x-speakeasy-group: loan-writeback.bank-accounts + '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + Exact (UK): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: Name + details: Must have a length between 1 and 60 characters + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Must have a length between 1 and 255 characters + information: [] + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank + type: String + displayName: Bank + required: false + - value: Asset.AccountReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Asset.CashAndBank + type: String + displayName: Cash + required: false + - value: Asset.Property Plant and Equipment + type: String + displayName: Equipment Machinery + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherLiability + type: String + displayName: Other Liability + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Equity.Equity + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Owner's Equity + type: String + displayName: Retained Earnings + required: false + - value: Income + type: String + displayName: Income + required: false + - value: OtherIncome + type: String + displayName: Other Income + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Expense.Expense + type: String + displayName: Sales Marketing + required: false + - value: Expense.Expense.Insurance + type: String + displayName: General Administrative + required: false + - value: Expense.Overhead + type: String + displayName: General Administrative + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repairs Maintenance + required: false + - value: OtherExpense + type: String + displayName: Other Expense + required: false + - value: CostOfSales + type: String + displayName: Cost of Sales + required: false + - value: Cost Of Goods Sold.Cost of Sales + type: String + displayName: Other + required: false + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Max length of 31 characters. + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Max length of 200 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.AccountsReceivable + type: String + displayName: Account Receivable + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Income.Income + type: String + displayName: Income + required: false + - value: Income.OtherIncome + type: String + displayName: Other Income + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.CostOfGoodsSold + type: String + displayName: Cost Of Goods Sold + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.OtherExpense + type: String + displayName: Other Expense + required: false + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Should not be longer than 200 characters. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: SALES + type: String + displayName: Sales + required: false + - value: OTHER_INCOME + type: String + displayName: Other Income + required: false + - value: DIRECT_EXPENSES + type: String + displayName: Direct Expenses + required: false + - value: OVERHEADS + type: String + displayName: Overheads + required: false + - value: DEPRECIATION + type: String + displayName: Depreciation + required: false + - value: CURRENT_ASSETS + type: String + displayName: Current Assets + required: false + - value: FIXED_ASSETS + type: String + displayName: Fixed Assets + required: false + - value: FUTURE_ASSETS + type: String + displayName: Future Assets + required: false + - value: BANK + type: String + displayName: Bank + required: false + - value: CURRENT_LIABILITY + type: String + displayName: Current Liability + required: false + - value: FUTURE_LIABILITY + type: String + displayName: Future Liability + required: false + - value: EQUITY + type: String + displayName: Equity + required: false + - value: LINE_OF_CREDIT + type: String + displayName: Credit Card / Loan + required: false + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Must be unique within the entity. + - field: NominalCode + details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + options: + - value: Asset + type: String + displayName: Asset + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Income + type: String + displayName: Income + required: false + - value: Liability + type: String + displayName: Liability + required: false + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' + required: true + Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + description: + type: String + displayName: Description + description: Description of the account + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + fullyQualifiedName: + type: String + displayName: Fully Qualified Name + description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales + required: true + currency: + type: String + displayName: Currency + description: The currency of the account + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + required: true + status: + type: String + displayName: Account Status + description: The status of the account + required: true + isBankAccount: + type: Boolean + displayName: Is Bank Account? + description: Confirms whether the nominal account represents a bank account or not + required: true + validDatatypeLinks: + type: Array + displayName: Valid Datatype Links + description: Describes which fields on other data types are valid links to this account in the originating system + properties: + property: + type: String + displayName: Property + description: The field on the source data type that other data types can link to + required: true + links: + type: Array + displayName: Links + description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: Identifier for the nominal account. + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 10 characters. + information: [] + name: + type: String + displayName: Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + validation: + warnings: [] + information: + - field: Name + details: Payments are enabled to this account if the name ends in .PaymentsEnabled. + description: + type: String + displayName: Description + description: Description for the nominal account. + required: false + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: Account type and category for nominal account. + options: + - value: Asset.Current + type: String + displayName: Current Asset + required: false + - value: Asset.Fixed + type: String + displayName: Fixed Asset + required: false + - value: Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.NonCurrent + type: String + displayName: Non-current Asset + required: false + - value: Asset.Prepayment + type: String + displayName: Prepayment + required: false + - value: Expense.DirectCosts + type: String + displayName: Direct Costs + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.Overhead + type: String + displayName: Overhead + required: false + - value: Expense.Superannuation + type: String + displayName: Superannuation + required: false + - value: Expense.Wages + type: String + displayName: Wages + required: false + - value: Income.Sales + type: String + displayName: Sales + required: false + - value: Income.Revenue + type: String + displayName: Revenue + required: false + - value: Income.Other + type: String + displayName: Other Income + required: false + - value: Liability.Current + type: String + displayName: Current Liability + required: false + - value: Liability.Depreciation + type: String + displayName: Depreciation + required: false + - value: Liability.Liability + type: String + displayName: Liability + required: false + - value: Liability.NonCurrent + type: String + displayName: Non Current Liability + required: false + - value: Liability.PayAsYouGo + type: String + displayName: Pay As You Go Liability + required: false + - value: Liability.Superannuation + type: String + displayName: Superannuation Liability + required: false + - value: Liability.WagesPayable + type: String + displayName: Wages Payable Liability + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-chartOfAccounts-model + x-speakeasy-group: loan-writeback.accounts + description: |- + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create account* endpoint creates a new [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). + operationId: create-account + x-speakeasy-group: loan-writeback.accounts + '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create source account + description: |- + The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software. + + > ### Versioning + > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. + operationId: create-source-account + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' + - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + examples: + Version 2: + value: + id: acc-001 + accountName: account-081 + accountType: checking + accountNumber: '12345670' + routingInfo: + bankCode: 021001088 + type: bankcode + currency: GBP + balance: 99.99 + accountInfo: + description: account description 1 + nickname: account 123 + accountOpenDate: '2023-05-06' + availableBalance: 10 + modifiedDate: '2024-08-02T00:00:00.000Z' + Version 1: + value: + id: acc-002 + accountName: account-081 + sortCode: '123456' + accountType: Credit + accountNumber: '12345670' + currency: GBP + balance: 99.99 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + responses: + '200': + description: Success + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2' + - $ref: '#/components/schemas/SourceAccount' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + x-speakeasy-group: loan-writeback.source-accounts + '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Loan writeback + summary: List bank feed account mappings + description: "\uFEFFThe *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts.\n\nA bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).\n\n> **For custom builds only**\n> \n> Only use this endpoint if you are building your own account management UI." + operationId: get-bank-account-mapping + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: list-mappings + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + examples: + Example: + value: + - sourceAccountId: account-001 + status: pending + targetAccountOptions: + - name: Money Bank account + id: d21e25d6-98c5-4bfb-b469-105833bea3c8 + accountNumber: '789' + sortCode: '123456' + - name: Bank of Dave account + id: d06ff4b2-e4f2-4681-9841-014bd008cdab + accountNumber: '99887766' + sortCode: '998866' + - name: LuxLend account + id: c8f252fc-84f3-4a8b-ace8-ae99f41a81ae + accountNumber: '123456789' + sortCode: '123456' + sourceAccountName: account-001 + sourceAccountNumber: '12345670' + sourceBalance: 99.99 + sourceCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + tags: + - Loan writeback + summary: Create bank feed account mapping + description: "\uFEFFThe *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account).\n\nA bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).\n\nTo find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint.\n\n> **For custom builds only**\n>\n> Only use this endpoint if you are building your own account management UI.\n\n#### Account mapping variability\n\nThe method of mapping the source account to the target account varies depending on the accounting software your company uses.\n\n#### Mapping options:\n\n1. **API Mapping**: Integrate the mapping journey directly into your application for a seamless user experience.\n2. **Codat UI Mapping**: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.\n3. **Accounting Platform Mapping**: For some accounting software, the mapping process must be conducted within the software itself.\n\n### Integration-specific behavior\n\n| Bank Feed Integration | API Mapping | Codat UI Mapping | Accounting Platform Mapping |\n| --------------------- | ----------- | ---------------- | --------------------------- |\n| Xero | ✅ | ✅ | |\n| FreeAgent | ✅ | ✅ | |\n| Oracle NetSuite | ✅ | ✅ | |\n| Exact Online (NL) | ✅ | ✅ | |\n| QuickBooks Online | | | ✅ |\n| Sage | | | ✅ |" + operationId: create-bank-account-mapping + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: create-mapping + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMapping' + examples: + Example: + value: + sourceAccountId: acc-002 + targetAccountId: account-081 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMappingResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/options/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update supplier model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + Exact (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + FreeAgent: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Only one address may be specified + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must not have the part after the first name longer than 30 characters. + - field: SupplierName + details: Must not have its first part (i.e. the first name) longer than 20 characters. + information: + - field: SupplierName + details: Must be provided and must contain a First and Last name separated by a ' '(space). + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: EmailAddress + details: Must not be longer than 255 characters. + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: Phone + details: Must not be longer than 21 characters. + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: [] + information: + - field: TaxNumber + details: Must not be longer than 19 characters. + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: [] + information: + - field: RegistrationNumber + details: Must not be longer than 14 characters. + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + required: false + - value: Unknown + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line1 + details: Must not be longer than 127 characters. + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line2 + details: Must not be longer than 127 characters. + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: [] + information: + - field: Addresses.City + details: Must not be longer than 255 characters. + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: [] + information: + - field: Addresses.Region + details: Must not be longer than 255 characters. + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.PostalCode + details: Must not be longer than 11 characters. + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Country + details: Must not be longer than 255 characters. + required: true + validation: + warnings: + - field: Addresses + details: Must only have 5 address entries at most. + information: + - field: Addresses + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing + required: false + - value: Delivery + type: String + displayName: Delivery + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: true + validation: + warnings: + - field: Addresses.Country + details: Must be a two letter Country ISO code + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: + - field: Addresses + details: Only one each of Billing and Delivery addresses can be provided + information: + - field: Addresses + details: Multiple addresses of Unknown type may be provided + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Max length of 41 characters. + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + validation: + warnings: + - field: ContactName + details: Max length of 25 characters for first and last names + information: [] + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Max length of 30 characters. + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + validation: + warnings: + - field: DefaultCurrency + details: 'Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company' + - field: DefaultCurrency + details: Can only be set if Multicurrency is enabled within the QuickBooks Desktop company + information: + - field: DefaultCurrency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 41 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 41 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 31 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 21 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 31 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Max length of 13 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: [] + information: + - field: Addresses.Type + details: Only 1 address each of type(s) Billing/Delivery may be specified. + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + id: + type: String + displayName: Id + description: ID of the supplier. + required: true + validation: + warnings: + - field: id + details: 'The supplier ID must be unique, contain no spaces and have a maximum of 8 characters.' + information: + - field: id + details: 'The supplier ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing.' + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + validation: + warnings: + - field: supplierName + details: The supplier name can have a maximum of 60 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier. + required: false + validation: + warnings: + - field: contactName + details: The contact name can have a maximum of 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The email address that the supplier may be contacted on. + required: false + phone: + type: String + displayName: Telephone + description: The telephone number that the supplier may be contacted on. + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: 'If not provided, the currency will default to the company''s base currency.' + required: false + status: + type: String + displayName: Status + description: The status of the supplier. + options: + - value: Active + type: String + displayName: Active Status + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Line 1 + description: Line 1 of the supplier address. + required: true + line2: + type: String + displayName: Line 2 + description: Line 2 of the supplier address. + required: false + city: + type: String + displayName: City + description: The city of the supplier address. + required: false + region: + type: String + displayName: Region + description: The region of the supplier address. + required: false + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Unknown + type: String + displayName: Unknown Address + required: false + required: false + validation: + warnings: [] + information: + - field: addresses.type + details: 'If Address type is not specified, it will default to type ''''Unknown''''' + required: false + validation: + warnings: + - field: addresses + details: Only one address can be included in the Addresses array. + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal company registration identifier. + required: false + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + validation: + warnings: + - field: Addresses.Line1 + details: 'If you''re adding an address for this Supplier, you must also include the first line' + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + country: + type: String + displayName: Country + description: The country for the address + options: + - value: Afghanistan (AF) + type: String + displayName: Afghanistan (AF) + required: false + - value: Albania (AL) + type: String + displayName: Albania (AL) + required: false + - value: Algeria (DZ) + type: String + displayName: Algeria (DZ) + required: false + - value: Andorra (AD) + type: String + displayName: Andorra (AD) + required: false + - value: Angola (AO) + type: String + displayName: Angola (AO) + required: false + - value: Argentina (AR) + type: String + displayName: Argentina (AR) + required: false + - value: Armenia (AM) + type: String + displayName: Armenia (AM) + required: false + - value: Aruba (AW) + type: String + displayName: Aruba (AW) + required: false + - value: Australia (AU) + type: String + displayName: Australia (AU) + required: false + - value: Austria (AT) + type: String + displayName: Austria (AT) + required: false + - value: Azerbaijan (AZ) + type: String + displayName: Azerbaijan (AZ) + required: false + - value: Bahamas (BS) + type: String + displayName: Bahamas (BS) + required: false + - value: Bahrain (BH) + type: String + displayName: Bahrain (BH) + required: false + - value: Bangladesh (BD) + type: String + displayName: Bangladesh (BD) + required: false + - value: Barbados (BB) + type: String + displayName: Barbados (BB) + required: false + - value: Belarus (BY) + type: String + displayName: Belarus (BY) + required: false + - value: Belgium (BE) + type: String + displayName: Belgium (BE) + required: false + - value: Belize (BZ) + type: String + displayName: Belize (BZ) + required: false + - value: Benin (BJ) + type: String + displayName: Benin (BJ) + required: false + - value: Bermuda (BM) + type: String + displayName: Bermuda (BM) + required: false + - value: Bhutan (BT) + type: String + displayName: Bhutan (BT) + required: false + - value: Bolivia (BO) + type: String + displayName: Bolivia (BO) + required: false + - value: Bosnia and Herzegovina (BA) + type: String + displayName: Bosnia and Herzegovina (BA) + required: false + - value: Botswana (BW) + type: String + displayName: Botswana (BW) + required: false + - value: Brazil (BR) + type: String + displayName: Brazil (BR) + required: false + - value: British Virgin Islands (VG) + type: String + displayName: British Virgin Islands (VG) + required: false + - value: Brunei Darussalam (BN) + type: String + displayName: Brunei Darussalam (BN) + required: false + - value: Bulgaria (BG) + type: String + displayName: Bulgaria (BG) + required: false + - value: Burkina Faso (BF) + type: String + displayName: Burkina Faso (BF) + required: false + - value: Burundi (BI) + type: String + displayName: Burundi (BI) + required: false + - value: Cambodia (KH) + type: String + displayName: Cambodia (KH) + required: false + - value: Cameroon (CM) + type: String + displayName: Cameroon (CM) + required: false + - value: Canada (CA) + type: String + displayName: Canada (CA) + required: false + - value: Cape Verde (CV) + type: String + displayName: Cape Verde (CV) + required: false + - value: Cayman Islands (KY) + type: String + displayName: Cayman Islands (KY) + required: false + - value: Central African Republic (CF) + type: String + displayName: Central African Republic (CF) + required: false + - value: Chad (TD) + type: String + displayName: Chad (TD) + required: false + - value: Chile (CL) + type: String + displayName: Chile (CL) + required: false + - value: China (CN) + type: String + displayName: China (CN) + required: false + - value: Colombia (CO) + type: String + displayName: Colombia (CO) + required: false + - value: Comoros (KM) + type: String + displayName: Comoros (KM) + required: false + - value: Congo (CG) + type: String + displayName: Congo (CG) + required: false + - value: Costa Rica (CR) + type: String + displayName: Costa Rica (CR) + required: false + - value: Croatia (HR) + type: String + displayName: Croatia (HR) + required: false + - value: Cuba (CU) + type: String + displayName: Cuba (CU) + required: false + - value: Cura�ao (CW) + type: String + displayName: Cura�ao (CW) + required: false + - value: Cyprus (CY) + type: String + displayName: Cyprus (CY) + required: false + - value: Czech Republic (CZ) + type: String + displayName: Czech Republic (CZ) + required: false + - value: Democratic Republic of the Congo (CD) + type: String + displayName: Democratic Republic of the Congo (CD) + required: false + - value: Denmark (DK) + type: String + displayName: Denmark (DK) + required: false + - value: Djibouti (DJ) + type: String + displayName: Djibouti (DJ) + required: false + - value: Dominica (DM) + type: String + displayName: Dominica (DM) + required: false + - value: Dominican Republic (DO) + type: String + displayName: Dominican Republic (DO) + required: false + - value: East Timor (TP) + type: String + displayName: East Timor (TP) + required: false + - value: Ecuador (EC) + type: String + displayName: Ecuador (EC) + required: false + - value: Egypt (EG) + type: String + displayName: Egypt (EG) + required: false + - value: El Salvador (SV) + type: String + displayName: El Salvador (SV) + required: false + - value: Equatorial Guinea (GQ) + type: String + displayName: Equatorial Guinea (GQ) + required: false + - value: Eritrea (ER) + type: String + displayName: Eritrea (ER) + required: false + - value: Estonia (EE) + type: String + displayName: Estonia (EE) + required: false + - value: Ethiopia (ET) + type: String + displayName: Ethiopia (ET) + required: false + - value: Falkland Islands (Malvinas) (FK) + type: String + displayName: Falkland Islands (Malvinas) (FK) + required: false + - value: Federated States of Micronesia (FM) + type: String + displayName: Federated States of Micronesia (FM) + required: false + - value: Fiji (FJ) + type: String + displayName: Fiji (FJ) + required: false + - value: Finland (FI) + type: String + displayName: Finland (FI) + required: false + - value: France (FR) + type: String + displayName: France (FR) + required: false + - value: French Polynesia (PF) + type: String + displayName: French Polynesia (PF) + required: false + - value: Gabon (GA) + type: String + displayName: Gabon (GA) + required: false + - value: Gambia (GM) + type: String + displayName: Gambia (GM) + required: false + - value: Georgia (GE) + type: String + displayName: Georgia (GE) + required: false + - value: Germany (DE) + type: String + displayName: Germany (DE) + required: false + - value: Ghana (GH) + type: String + displayName: Ghana (GH) + required: false + - value: Gibraltar (GI) + type: String + displayName: Gibraltar (GI) + required: false + - value: Greece (GR) + type: String + displayName: Greece (GR) + required: false + - value: Greenland (GL) + type: String + displayName: Greenland (GL) + required: false + - value: Grenada (GD) + type: String + displayName: Grenada (GD) + required: false + - value: Guadaloupe (GP) + type: String + displayName: Guadaloupe (GP) + required: false + - value: Guam (GU) + type: String + displayName: Guam (GU) + required: false + - value: Guatemala (GT) + type: String + displayName: Guatemala (GT) + required: false + - value: Guernsey (GG) + type: String + displayName: Guernsey (GG) + required: false + - value: Guinea (GN) + type: String + displayName: Guinea (GN) + required: false + - value: Guinea-Bissau (GW) + type: String + displayName: Guinea-Bissau (GW) + required: false + - value: Guyana (GY) + type: String + displayName: Guyana (GY) + required: false + - value: Haiti (HT) + type: String + displayName: Haiti (HT) + required: false + - value: Honduras (HN) + type: String + displayName: Honduras (HN) + required: false + - value: Hong Kong (HK) + type: String + displayName: Hong Kong (HK) + required: false + - value: Hungary (HU) + type: String + displayName: Hungary (HU) + required: false + - value: Iceland (IS) + type: String + displayName: Iceland (IS) + required: false + - value: India (IN) + type: String + displayName: India (IN) + required: false + - value: Indonesia (ID) + type: String + displayName: Indonesia (ID) + required: false + - value: Iran (IR) + type: String + displayName: Iran (IR) + required: false + - value: Iraq (IQ) + type: String + displayName: Iraq (IQ) + required: false + - value: Ireland (IE) + type: String + displayName: Ireland (IE) + required: false + - value: Israel (IL) + type: String + displayName: Israel (IL) + required: false + - value: Italy (IT) + type: String + displayName: Italy (IT) + required: false + - value: Ivory Coast (CI) + type: String + displayName: Ivory Coast (CI) + required: false + - value: Jamaica (JM) + type: String + displayName: Jamaica (JM) + required: false + - value: Japan (JP) + type: String + displayName: Japan (JP) + required: false + - value: Jersey (JE) + type: String + displayName: Jersey (JE) + required: false + - value: Jordan (JO) + type: String + displayName: Jordan (JO) + required: false + - value: Kazakhstan (KZ) + type: String + displayName: Kazakhstan (KZ) + required: false + - value: Kenya (KE) + type: String + displayName: Kenya (KE) + required: false + - value: Kuwait (KW) + type: String + displayName: Kuwait (KW) + required: false + - value: Kyrgyzstan (KG) + type: String + displayName: Kyrgyzstan (KG) + required: false + - value: Laos (LA) + type: String + displayName: Laos (LA) + required: false + - value: Latvia (LV) + type: String + displayName: Latvia (LV) + required: false + - value: Lebanon (LB) + type: String + displayName: Lebanon (LB) + required: false + - value: Lesotho (LS) + type: String + displayName: Lesotho (LS) + required: false + - value: Liberia (LR) + type: String + displayName: Liberia (LR) + required: false + - value: Libya (LY) + type: String + displayName: Libya (LY) + required: false + - value: Liechtenstein (LI) + type: String + displayName: Liechtenstein (LI) + required: false + - value: Lithuania (LT) + type: String + displayName: Lithuania (LT) + required: false + - value: Luxembourg (LU) + type: String + displayName: Luxembourg (LU) + required: false + - value: Macau (MO) + type: String + displayName: Macau (MO) + required: false + - value: Macedonia (MK) + type: String + displayName: Macedonia (MK) + required: false + - value: Madagascar (MG) + type: String + displayName: Madagascar (MG) + required: false + - value: Malawi (MW) + type: String + displayName: Malawi (MW) + required: false + - value: Malaysia (MY) + type: String + displayName: Malaysia (MY) + required: false + - value: Maldives (MV) + type: String + displayName: Maldives (MV) + required: false + - value: Mali (ML) + type: String + displayName: Mali (ML) + required: false + - value: Malta (MT) + type: String + displayName: Malta (MT) + required: false + - value: Mauritania (MR) + type: String + displayName: Mauritania (MR) + required: false + - value: Mauritius (MU) + type: String + displayName: Mauritius (MU) + required: false + - value: Mexico (MX) + type: String + displayName: Mexico (MX) + required: false + - value: Moldova (MD) + type: String + displayName: Moldova (MD) + required: false + - value: Monaco (MC) + type: String + displayName: Monaco (MC) + required: false + - value: Mongolia (MN) + type: String + displayName: Mongolia (MN) + required: false + - value: Montenegro (ME) + type: String + displayName: Montenegro (ME) + required: false + - value: Morocco (MA) + type: String + displayName: Morocco (MA) + required: false + - value: Mozambique (MZ) + type: String + displayName: Mozambique (MZ) + required: false + - value: Myanmar (MM) + type: String + displayName: Myanmar (MM) + required: false + - value: Namibia (NA) + type: String + displayName: Namibia (NA) + required: false + - value: Nepal (NP) + type: String + displayName: Nepal (NP) + required: false + - value: Netherlands (NL) + type: String + displayName: Netherlands (NL) + required: false + - value: Netherlands Antilles (AN) + type: String + displayName: Netherlands Antilles (AN) + required: false + - value: New Caledonia (NC) + type: String + displayName: New Caledonia (NC) + required: false + - value: New Zealand (NZ) + type: String + displayName: New Zealand (NZ) + required: false + - value: Nicaragua (NI) + type: String + displayName: Nicaragua (NI) + required: false + - value: Niger (NE) + type: String + displayName: Niger (NE) + required: false + - value: Nigeria (NG) + type: String + displayName: Nigeria (NG) + required: false + - value: North Korea (KP) + type: String + displayName: North Korea (KP) + required: false + - value: Norway (NO) + type: String + displayName: Norway (NO) + required: false + - value: Oman (OM) + type: String + displayName: Oman (OM) + required: false + - value: Pakistan (PK) + type: String + displayName: Pakistan (PK) + required: false + - value: Panama (PA) + type: String + displayName: Panama (PA) + required: false + - value: Papua New Guinea (PG) + type: String + displayName: Papua New Guinea (PG) + required: false + - value: Paraguay (PY) + type: String + displayName: Paraguay (PY) + required: false + - value: Peru (PE) + type: String + displayName: Peru (PE) + required: false + - value: Philippines (PH) + type: String + displayName: Philippines (PH) + required: false + - value: Poland (PL) + type: String + displayName: Poland (PL) + required: false + - value: Portugal (PT) + type: String + displayName: Portugal (PT) + required: false + - value: Puerto Rico (PR) + type: String + displayName: Puerto Rico (PR) + required: false + - value: Qatar (QA) + type: String + displayName: Qatar (QA) + required: false + - value: Romania (RO) + type: String + displayName: Romania (RO) + required: false + - value: Russia (RU) + type: String + displayName: Russia (RU) + required: false + - value: Rwanda (RW) + type: String + displayName: Rwanda (RW) + required: false + - value: Saint Kitts and Nevis (KN) + type: String + displayName: Saint Kitts and Nevis (KN) + required: false + - value: Saint Pierre and Miquelon (PM) + type: String + displayName: Saint Pierre and Miquelon (PM) + required: false + - value: Samoa (WS) + type: String + displayName: Samoa (WS) + required: false + - value: San Marino (SM) + type: String + displayName: San Marino (SM) + required: false + - value: Sao Tome and Principe (ST) + type: String + displayName: Sao Tome and Principe (ST) + required: false + - value: Saudi Arabia (SA) + type: String + displayName: Saudi Arabia (SA) + required: false + - value: Senegal (SN) + type: String + displayName: Senegal (SN) + required: false + - value: Serbia (RS) + type: String + displayName: Serbia (RS) + required: false + - value: Seychelles (SC) + type: String + displayName: Seychelles (SC) + required: false + - value: Sierra Leone (SL) + type: String + displayName: Sierra Leone (SL) + required: false + - value: Singapore (SG) + type: String + displayName: Singapore (SG) + required: false + - value: Slovakia (SK) + type: String + displayName: Slovakia (SK) + required: false + - value: Slovenia (SI) + type: String + displayName: Slovenia (SI) + required: false + - value: Solomon Islands (SB) + type: String + displayName: Solomon Islands (SB) + required: false + - value: Somalia (SO) + type: String + displayName: Somalia (SO) + required: false + - value: South Africa (ZA) + type: String + displayName: South Africa (ZA) + required: false + - value: South Korea (KR) + type: String + displayName: South Korea (KR) + required: false + - value: Spain (ES) + type: String + displayName: Spain (ES) + required: false + - value: Sri Lanka (LK) + type: String + displayName: Sri Lanka (LK) + required: false + - value: St. Lucia (LC) + type: String + displayName: St. Lucia (LC) + required: false + - value: Sudan (SD) + type: String + displayName: Sudan (SD) + required: false + - value: Surinam (SR) + type: String + displayName: Surinam (SR) + required: false + - value: Swaziland (SZ) + type: String + displayName: Swaziland (SZ) + required: false + - value: Sweden (SE) + type: String + displayName: Sweden (SE) + required: false + - value: Switzerland (CH) + type: String + displayName: Switzerland (CH) + required: false + - value: Syria (SY) + type: String + displayName: Syria (SY) + required: false + - value: Taiwan (TW) + type: String + displayName: Taiwan (TW) + required: false + - value: Tajikistan (TJ) + type: String + displayName: Tajikistan (TJ) + required: false + - value: Tanzania (TZ) + type: String + displayName: Tanzania (TZ) + required: false + - value: Thailand (TH) + type: String + displayName: Thailand (TH) + required: false + - value: Togo (TG) + type: String + displayName: Togo (TG) + required: false + - value: Tonga (TO) + type: String + displayName: Tonga (TO) + required: false + - value: Trinidad and Tobago (TT) + type: String + displayName: Trinidad and Tobago (TT) + required: false + - value: Tunisia (TN) + type: String + displayName: Tunisia (TN) + required: false + - value: Turkey (TR) + type: String + displayName: Turkey (TR) + required: false + - value: Turkmenistan (TM) + type: String + displayName: Turkmenistan (TM) + required: false + - value: Tuvalu (TV) + type: String + displayName: Tuvalu (TV) + required: false + - value: Uganda (UG) + type: String + displayName: Uganda (UG) + required: false + - value: Ukraine (UA) + type: String + displayName: Ukraine (UA) + required: false + - value: United Arab Emirates (AE) + type: String + displayName: United Arab Emirates (AE) + required: false + - value: United Kingdom (GB) + type: String + displayName: United Kingdom (GB) + required: false + - value: United States (US) + type: String + displayName: United States (US) + required: false + - value: Uruguay (UY) + type: String + displayName: Uruguay (UY) + required: false + - value: Uzbekistan (UZ) + type: String + displayName: Uzbekistan (UZ) + required: false + - value: Vanuatu (VU) + type: String + displayName: Vanuatu (VU) + required: false + - value: Venezuela (VE) + type: String + displayName: Venezuela (VE) + required: false + - value: Vietnam (VN) + type: String + displayName: Vietnam (VN) + required: false + - value: Virgin Islands U.S. (VI) + type: String + displayName: Virgin Islands U.S. (VI) + required: false + - value: Western Sahara (EH) + type: String + displayName: Western Sahara (EH) + required: false + - value: Yemen (YE) + type: String + displayName: Yemen (YE) + required: false + - value: Zaire (ZR) + type: String + displayName: Zaire (ZR) + required: false + - value: Zambia (ZM) + type: String + displayName: Zambia (ZM) + required: false + - value: Zimbabwe (ZW) + type: String + displayName: Zimbabwe (ZW) + required: false + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Can contain a maximum of one address + required: true + Sage Intacct: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must be between 1 and 100 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + validation: + warnings: + - field: ContactName + details: Must be between 1 and 200 characters + information: [] + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: Must be no greater than 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: + - field: EmailAddress + details: Must be no greater than 200 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Must be no greater than 20 characters + information: [] + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: Must be no greater than 100 characters + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + - value: CAD + type: String + displayName: Canadian Dollar + required: false + - value: GBP + type: String + displayName: Pound Sterling + required: false + - value: USD + type: String + displayName: US Dollar + required: false + - value: ZAR + type: String + displayName: Rand + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Must be no greater than 200 characters + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Must be no greater than 200 characters + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Must be no greater than 80 characters + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Must be no greater than 40 characters + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Must be no greater than 30 characters + information: [] + country: + type: String + displayName: Country + description: The country for the address + options: + - value: United States + type: String + displayName: United States + required: false + - value: Afghanistan + type: String + displayName: Afghanistan + required: false + - value: Aland Islands + type: String + displayName: Aland Islands + required: false + - value: Albania + type: String + displayName: Albania + required: false + - value: Algeria + type: String + displayName: Algeria + required: false + - value: American Samoa + type: String + displayName: American Samoa + required: false + - value: Andorra + type: String + displayName: Andorra + required: false + - value: Angola + type: String + displayName: Angola + required: false + - value: Anguilla + type: String + displayName: Anguilla + required: false + - value: Antarctica + type: String + displayName: Antarctica + required: false + - value: Antigua and Barbuda + type: String + displayName: Antigua and Barbuda + required: false + - value: Argentina + type: String + displayName: Argentina + required: false + - value: Armenia + type: String + displayName: Armenia + required: false + - value: Aruba + type: String + displayName: Aruba + required: false + - value: Australia + type: String + displayName: Australia + required: false + - value: Austria + type: String + displayName: Austria + required: false + - value: Azerbaijan + type: String + displayName: Azerbaijan + required: false + - value: Bahamas + type: String + displayName: Bahamas + required: false + - value: Bahrain + type: String + displayName: Bahrain + required: false + - value: Bangladesh + type: String + displayName: Bangladesh + required: false + - value: Barbados + type: String + displayName: Barbados + required: false + - value: Belarus + type: String + displayName: Belarus + required: false + - value: Belgium + type: String + displayName: Belgium + required: false + - value: Belize + type: String + displayName: Belize + required: false + - value: Benin + type: String + displayName: Benin + required: false + - value: Bermuda + type: String + displayName: Bermuda + required: false + - value: Bhutan + type: String + displayName: Bhutan + required: false + - value: Bolivia + type: String + displayName: Bolivia + required: false + - value: 'Bonaire, Sint Eustatius and Saba' + type: String + displayName: 'Bonaire, Sint Eustatius and Saba' + required: false + - value: Bosnia and Herzegovina + type: String + displayName: Bosnia and Herzegovina + required: false + - value: Botswana + type: String + displayName: Botswana + required: false + - value: Bouvet Island + type: String + displayName: Bouvet Island + required: false + - value: Brazil + type: String + displayName: Brazil + required: false + - value: British Indian Ocean Territory + type: String + displayName: British Indian Ocean Territory + required: false + - value: Brunei Darussalam + type: String + displayName: Brunei Darussalam + required: false + - value: Bulgaria + type: String + displayName: Bulgaria + required: false + - value: Burkina Faso + type: String + displayName: Burkina Faso + required: false + - value: Burundi + type: String + displayName: Burundi + required: false + - value: Cambodia + type: String + displayName: Cambodia + required: false + - value: Cameroon + type: String + displayName: Cameroon + required: false + - value: Canada + type: String + displayName: Canada + required: false + - value: Cape Verde + type: String + displayName: Cape Verde + required: false + - value: Cayman Islands + type: String + displayName: Cayman Islands + required: false + - value: Central African Republic + type: String + displayName: Central African Republic + required: false + - value: Chad + type: String + displayName: Chad + required: false + - value: Chile + type: String + displayName: Chile + required: false + - value: China + type: String + displayName: China + required: false + - value: Christmas Island + type: String + displayName: Christmas Island + required: false + - value: Cocos (Keeling) Islands + type: String + displayName: Cocos (Keeling) Islands + required: false + - value: Colombia + type: String + displayName: Colombia + required: false + - value: Comoros + type: String + displayName: Comoros + required: false + - value: Congo + type: String + displayName: Congo + required: false + - value: 'Congo, Democratic Republic' + type: String + displayName: 'Congo, Democratic Republic' + required: false + - value: Cook Islands + type: String + displayName: Cook Islands + required: false + - value: Costa Rica + type: String + displayName: Costa Rica + required: false + - value: C�te d'Ivoire + type: String + displayName: C�te d'Ivoire + required: false + - value: Croatia + type: String + displayName: Croatia + required: false + - value: Cuba + type: String + displayName: Cuba + required: false + - value: Cura�ao + type: String + displayName: Cura�ao + required: false + - value: Cyprus + type: String + displayName: Cyprus + required: false + - value: Czech Republic + type: String + displayName: Czech Republic + required: false + - value: Denmark + type: String + displayName: Denmark + required: false + - value: Djibouti + type: String + displayName: Djibouti + required: false + - value: Dominica + type: String + displayName: Dominica + required: false + - value: Dominican Republic + type: String + displayName: Dominican Republic + required: false + - value: Ecuador + type: String + displayName: Ecuador + required: false + - value: Egypt + type: String + displayName: Egypt + required: false + - value: El Salvador + type: String + displayName: El Salvador + required: false + - value: Equatorial Guinea + type: String + displayName: Equatorial Guinea + required: false + - value: Eritrea + type: String + displayName: Eritrea + required: false + - value: Estonia + type: String + displayName: Estonia + required: false + - value: Eswatini + type: String + displayName: Eswatini + required: false + - value: Ethiopia + type: String + displayName: Ethiopia + required: false + - value: Falkland Islands (Malvinas + type: String + displayName: Falkland Islands (Malvinas + required: false + - value: Faroe Islands + type: String + displayName: Faroe Islands + required: false + - value: Fiji + type: String + displayName: Fiji + required: false + - value: Finland + type: String + displayName: Finland + required: false + - value: France + type: String + displayName: France + required: false + - value: French Guiana + type: String + displayName: French Guiana + required: false + - value: French Polynesia + type: String + displayName: French Polynesia + required: false + - value: French Southern Territories + type: String + displayName: French Southern Territories + required: false + - value: Gabon + type: String + displayName: Gabon + required: false + - value: Gambia + type: String + displayName: Gambia + required: false + - value: Georgia + type: String + displayName: Georgia + required: false + - value: Germany + type: String + displayName: Germany + required: false + - value: Ghana + type: String + displayName: Ghana + required: false + - value: Gibraltar + type: String + displayName: Gibraltar + required: false + - value: Greece + type: String + displayName: Greece + required: false + - value: Greenland + type: String + displayName: Greenland + required: false + - value: Grenada + type: String + displayName: Grenada + required: false + - value: Guadeloupe + type: String + displayName: Guadeloupe + required: false + - value: Guam + type: String + displayName: Guam + required: false + - value: Guatemala + type: String + displayName: Guatemala + required: false + - value: Guernsey + type: String + displayName: Guernsey + required: false + - value: Guinea + type: String + displayName: Guinea + required: false + - value: Guinea-Bissau + type: String + displayName: Guinea-Bissau + required: false + - value: Guyana + type: String + displayName: Guyana + required: false + - value: Haiti + type: String + displayName: Haiti + required: false + - value: Heard Is. & Mcdonald Islands + type: String + displayName: Heard Is. & Mcdonald Islands + required: false + - value: Honduras + type: String + displayName: Honduras + required: false + - value: Hong Kong + type: String + displayName: Hong Kong + required: false + - value: Hungary + type: String + displayName: Hungary + required: false + - value: Iceland + type: String + displayName: Iceland + required: false + - value: India + type: String + displayName: India + required: false + - value: Indonesia + type: String + displayName: Indonesia + required: false + - value: 'Iran, Islamic Republic of' + type: String + displayName: 'Iran, Islamic Republic of' + required: false + - value: Iraq + type: String + displayName: Iraq + required: false + - value: Ireland + type: String + displayName: Ireland + required: false + - value: Isle of Man + type: String + displayName: Isle of Man + required: false + - value: Israel + type: String + displayName: Israel + required: false + - value: Italy + type: String + displayName: Italy + required: false + - value: Jamaica + type: String + displayName: Jamaica + required: false + - value: Japan + type: String + displayName: Japan + required: false + - value: Jersey + type: String + displayName: Jersey + required: false + - value: Jordan + type: String + displayName: Jordan + required: false + - value: Kazakhstan + type: String + displayName: Kazakhstan + required: false + - value: Kenya + type: String + displayName: Kenya + required: false + - value: Kiribati + type: String + displayName: Kiribati + required: false + - value: 'Korea, Republic of' + type: String + displayName: 'Korea, Republic of' + required: false + - value: 'Korea, Demo. People''s Rep' + type: String + displayName: 'Korea, Demo. People''s Rep' + required: false + - value: Kosovo + type: String + displayName: Kosovo + required: false + - value: Kuwait + type: String + displayName: Kuwait + required: false + - value: Kyrgyzstan + type: String + displayName: Kyrgyzstan + required: false + - value: Lao + type: String + displayName: Lao + required: false + - value: Latvia + type: String + displayName: Latvia + required: false + - value: Lebanon + type: String + displayName: Lebanon + required: false + - value: Lesotho + type: String + displayName: Lesotho + required: false + - value: Liberia + type: String + displayName: Liberia + required: false + - value: Libyan Arab Jamahiriya + type: String + displayName: Libyan Arab Jamahiriya + required: false + - value: Liechtenstein + type: String + displayName: Liechtenstein + required: false + - value: Lithuania + type: String + displayName: Lithuania + required: false + - value: Luxembourg + type: String + displayName: Luxembourg + required: false + - value: Macao + type: String + displayName: Macao + required: false + - value: Macedonia + type: String + displayName: Macedonia + required: false + - value: Madagascar + type: String + displayName: Madagascar + required: false + - value: Malawi + type: String + displayName: Malawi + required: false + - value: Malaysia + type: String + displayName: Malaysia + required: false + - value: Maldives + type: String + displayName: Maldives + required: false + - value: Mali + type: String + displayName: Mali + required: false + - value: Malta + type: String + displayName: Malta + required: false + - value: Marshall Islands + type: String + displayName: Marshall Islands + required: false + - value: Martinique + type: String + displayName: Martinique + required: false + - value: Mauritania + type: String + displayName: Mauritania + required: false + - value: Mauritius + type: String + displayName: Mauritius + required: false + - value: Mayotte + type: String + displayName: Mayotte + required: false + - value: Mexico + type: String + displayName: Mexico + required: false + - value: Micronesia + type: String + displayName: Micronesia + required: false + - value: 'Moldova, Republic of' + type: String + displayName: 'Moldova, Republic of' + required: false + - value: Monaco + type: String + displayName: Monaco + required: false + - value: Mongolia + type: String + displayName: Mongolia + required: false + - value: Montenegro + type: String + displayName: Montenegro + required: false + - value: Montserrat + type: String + displayName: Montserrat + required: false + - value: Morocco + type: String + displayName: Morocco + required: false + - value: Mozambique + type: String + displayName: Mozambique + required: false + - value: Myanmar + type: String + displayName: Myanmar + required: false + - value: Namibia + type: String + displayName: Namibia + required: false + - value: Nauru + type: String + displayName: Nauru + required: false + - value: Nepal + type: String + displayName: Nepal + required: false + - value: Netherlands + type: String + displayName: Netherlands + required: false + - value: Netherlands Antilles + type: String + displayName: Netherlands Antilles + required: false + - value: New Caledonia + type: String + displayName: New Caledonia + required: false + - value: New Zealand + type: String + displayName: New Zealand + required: false + - value: Nicaragua + type: String + displayName: Nicaragua + required: false + - value: Niger + type: String + displayName: Niger + required: false + - value: Nigeria + type: String + displayName: Nigeria + required: false + - value: Niue + type: String + displayName: Niue + required: false + - value: Norfolk Island + type: String + displayName: Norfolk Island + required: false + - value: Northern Mariana Islands + type: String + displayName: Northern Mariana Islands + required: false + - value: Norway + type: String + displayName: Norway + required: false + - value: Oman + type: String + displayName: Oman + required: false + - value: Pakistan + type: String + displayName: Pakistan + required: false + - value: Palau + type: String + displayName: Palau + required: false + - value: 'Palestinian Territory, Occupied' + type: String + displayName: 'Palestinian Territory, Occupied' + required: false + - value: Panama + type: String + displayName: Panama + required: false + - value: Papua New Guinea + type: String + displayName: Papua New Guinea + required: false + - value: Paraguay + type: String + displayName: Paraguay + required: false + - value: Peru + type: String + displayName: Peru + required: false + - value: Philippines + type: String + displayName: Philippines + required: false + - value: Pitcairn + type: String + displayName: Pitcairn + required: false + - value: Poland + type: String + displayName: Poland + required: false + - value: Portugal + type: String + displayName: Portugal + required: false + - value: Puerto Rico + type: String + displayName: Puerto Rico + required: false + - value: Qatar + type: String + displayName: Qatar + required: false + - value: Reunion + type: String + displayName: Reunion + required: false + - value: Romania + type: String + displayName: Romania + required: false + - value: Russian Federation + type: String + displayName: Russian Federation + required: false + - value: Rwanda + type: String + displayName: Rwanda + required: false + - value: Saint Barthelemy + type: String + displayName: Saint Barthelemy + required: false + - value: Saint Helena + type: String + displayName: Saint Helena + required: false + - value: Saint Kitts and Nevis + type: String + displayName: Saint Kitts and Nevis + required: false + - value: Saint Lucia + type: String + displayName: Saint Lucia + required: false + - value: Saint Martin + type: String + displayName: Saint Martin + required: false + - value: Saint Pierre and Miquelon + type: String + displayName: Saint Pierre and Miquelon + required: false + - value: Saint Vincent and the Grenadines + type: String + displayName: Saint Vincent and the Grenadines + required: false + - value: Samoa + type: String + displayName: Samoa + required: false + - value: San Marino + type: String + displayName: San Marino + required: false + - value: Sao Tome and Principe + type: String + displayName: Sao Tome and Principe + required: false + - value: Saudi Arabia + type: String + displayName: Saudi Arabia + required: false + - value: Senegal + type: String + displayName: Senegal + required: false + - value: Serbia + type: String + displayName: Serbia + required: false + - value: Seychelles + type: String + displayName: Seychelles + required: false + - value: Sierra Leone + type: String + displayName: Sierra Leone + required: false + - value: Singapore + type: String + displayName: Singapore + required: false + - value: Sint Maarten + type: String + displayName: Sint Maarten + required: false + - value: Slovakia + type: String + displayName: Slovakia + required: false + - value: Slovenia + type: String + displayName: Slovenia + required: false + - value: Solomon Islands + type: String + displayName: Solomon Islands + required: false + - value: Somalia + type: String + displayName: Somalia + required: false + - value: South Africa + type: String + displayName: South Africa + required: false + - value: S. Georgia & S. Sandwich Is + type: String + displayName: S. Georgia & S. Sandwich Is + required: false + - value: Spain + type: String + displayName: Spain + required: false + - value: Sri Lanka + type: String + displayName: Sri Lanka + required: false + - value: Sudan + type: String + displayName: Sudan + required: false + - value: South Sudan + type: String + displayName: South Sudan + required: false + - value: Suriname + type: String + displayName: Suriname + required: false + - value: Svalbard and Jan Mayen + type: String + displayName: Svalbard and Jan Mayen + required: false + - value: Sweden + type: String + displayName: Sweden + required: false + - value: Switzerland + type: String + displayName: Switzerland + required: false + - value: Syrian Arab Republic + type: String + displayName: Syrian Arab Republic + required: false + - value: Taiwan + type: String + displayName: Taiwan + required: false + - value: Tajikistan + type: String + displayName: Tajikistan + required: false + - value: 'Tanzania, United Republic of' + type: String + displayName: 'Tanzania, United Republic of' + required: false + - value: Thailand + type: String + displayName: Thailand + required: false + - value: Timor-Leste + type: String + displayName: Timor-Leste + required: false + - value: Togo + type: String + displayName: Togo + required: false + - value: Tokelau + type: String + displayName: Tokelau + required: false + - value: Tonga + type: String + displayName: Tonga + required: false + - value: Trinidad and Tobago + type: String + displayName: Trinidad and Tobago + required: false + - value: Tunisia + type: String + displayName: Tunisia + required: false + - value: Turkey + type: String + displayName: Turkey + required: false + - value: Turkmenistan + type: String + displayName: Turkmenistan + required: false + - value: Turks and Caicos Islands + type: String + displayName: Turks and Caicos Islands + required: false + - value: Tuvalu + type: String + displayName: Tuvalu + required: false + - value: Uganda + type: String + displayName: Uganda + required: false + - value: Ukraine + type: String + displayName: Ukraine + required: false + - value: United Arab Emirates + type: String + displayName: United Arab Emirates + required: false + - value: United Kingdom + type: String + displayName: United Kingdom + required: false + - value: US Minor Outlying Islands + type: String + displayName: US Minor Outlying Islands + required: false + - value: Uruguay + type: String + displayName: Uruguay + required: false + - value: Uzbekistan + type: String + displayName: Uzbekistan + required: false + - value: Vanuatu + type: String + displayName: Vanuatu + required: false + - value: Vatican City State + type: String + displayName: Vatican City State + required: false + - value: Venezuela + type: String + displayName: Venezuela + required: false + - value: Vietnam + type: String + displayName: Vietnam + required: false + - value: 'Virgin Islands, British' + type: String + displayName: 'Virgin Islands, British' + required: false + - value: 'Virgin Islands, U.S' + type: String + displayName: 'Virgin Islands, U.S' + required: false + - value: Wallis and Futuna + type: String + displayName: Wallis and Futuna + required: false + - value: Western Sahara + type: String + displayName: Western Sahara + required: false + - value: Yemen + type: String + displayName: Yemen + required: false + - value: Zambia + type: String + displayName: Zambia + required: false + - value: Zimbabwe + type: String + displayName: Zimbabwe + required: false + required: false + validation: + warnings: + - field: Addresses.Country + details: Required if TaxNumber is supplied + information: [] + required: false + validation: + warnings: + - field: Addresses + details: 'If supplied, must contain only 1 address' + - field: Addresses + details: 'If TaxNumber is supplied, an Address with a Country is required' + information: [] + required: true + Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: true + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: true + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: true + country: + type: String + displayName: Country + description: The country for the address + required: true + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: true + required: true + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: true + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + required: true + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Suppliers + description: 'An accounts payable contact that supplies good or services, also referred to as a vendor.' + properties: + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + phone: + type: String + displayName: Phone + description: Main contact phone number for the supplier. + required: false + validation: + warnings: + - field: phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email + description: Main contact email for the supplier. + required: false + registrationNumber: + type: String + displayName: Registration Number + description: Legal company registration identifier. + required: false + validation: + warnings: + - field: registrationNumber + details: Max length of 50 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal tax registration identifier. + required: false + status: + type: String + displayName: Status + description: Status of the supplier account. + options: + - value: Active + type: String + displayName: Active + required: false + - value: InActive + type: String + displayName: Inactive + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Address Line 1 + description: First line of the address. + required: false + validation: + warnings: + - field: addresses.line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Address Line 2 + description: Second line of the address. + required: false + validation: + warnings: + - field: addresses.line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: Local city for the address. + required: false + validation: + warnings: + - field: addresses.city + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: Region the address is located in. + required: false + validation: + warnings: + - field: addresses.region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: Country for the address. + required: false + validation: + warnings: + - field: addresses.country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + validation: + warnings: + - field: addresses.postalCode + details: Only English alphabet characters are permitted. + - field: addresses.postalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: + - field: addresses.type + details: 'Billing = POBOX, Delivery/Unknown = DELIVERY' + information: [] + required: false + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-suppliers-model + x-speakeasy-group: loan-writeback.suppliers + description: "The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behavior**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" + '/companies/{companyId}/connections/{connectionId}/push/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Sage Intacct: + value: + id: '73593' + supplierName: test 20230420 1004 + contactName: Joe Bloggs + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create supplier + description: "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behavior**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model).\r\n" + operationId: create-supplier + x-speakeasy-group: loan-writeback.suppliers + '/companies/{companyId}/connections/{connectionId}/options/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create transfer model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be provided and be greater than zero. + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: false + validation: + warnings: + - field: To.Amount + details: 'If provided, must be greater than zero.' + - field: To.Amount + details: It will be taken into account just if the accounts are in different currencies and will override the automatic currency conversion. + information: [] + required: true + required: true + Oracle NetSuite: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: false + validation: + warnings: [] + information: + - field: Date + details: Will default to today's date if not provided + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.Id + details: 'One location, one department and one classification may be provided' + information: [] + required: false + required: true + validation: + warnings: + - details: Currently only transfers between bank accounts and undeposited funds accounts are supported + information: [] + QuickBooks Desktop: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Value should match To.Amount + - field: From.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: From.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Value should match To.Amount + - field: To.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: To.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + required: false + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Max length of 4096 characters. + information: [] + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + required: false + validation: + warnings: + - field: ContactRef + details: 'This value is not used in the push, and will be ignored.' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + QuickBooks Online: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + Sage Business Cloud Accounting: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Must be provided if pushing a bank deposit. + information: + - field: Description + details: Must not be longer than 2000 characters. + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from To.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from From.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + required: true + required: true + Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: From.Status + details: Must be provided. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: To.Status + details: Must be provided. + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-transfers-model + x-speakeasy-group: loan-writeback.transfers + description: | + The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + summary: Create transfer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + QuickBooks Desktop: + value: + description: test transfers push 20230126 12.08 + contactRef: + id: 80000028-167239230944 + dataType: customers + date: '2023-01-26T11:51:18.104Z' + from: + accountRef: + id: 80000028-1671794219 + dataType: bankAccounts + amount: 12 + to: + accountRef: + id: 80000004-1671793811 + dataType: bankAccounts + amount: 12 + status: Unknown + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + metadata: + isDeleted: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateTransferResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). + operationId: create-transfer + x-speakeasy-group: loan-writeback.transfers + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Loan writeback + summary: Get create bank account transactions model + description: |- + The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + operationId: get-create-bank-transactions-model + x-speakeasy-group: loan-writeback.bank-transactions + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + post: + tags: + - Loan writeback + summary: Create bank account transactions + description: | + The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/lending-api#/operations/get-create-bankTransactions-model). + operationId: create-bank-transactions + x-speakeasy-group: loan-writeback.bank-transactions + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactions' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactionsResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/options/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create direct cost model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: [] + information: + - field: Note + details: is not supported and will be ignored + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: is not supported and will be ignored + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If unspecified, base currency is assumed. Must agree with the bank account in PaymentAllocations' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Required if the currency is not the base currency + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + validation: + warnings: [] + information: + - field: SubTotal + details: is not supported and will be ignored + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + validation: + warnings: [] + information: + - field: TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: is not supported and will be ignored + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: is not supported and will be ignored + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: is not supported and will be ignored + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountAmount + details: is not supported and will be ignored + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountPercentage + details: is not supported and will be ignored + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Required if totalAmount is not specified + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Required if subTotal is not specified + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.Name + details: is not supported and will be ignored + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.EffectiveTaxRate + details: is not supported and will be ignored + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: false + validation: + warnings: [] + information: + - field: LineItems.ItemRef + details: is not supported and will be ignored + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: is not supported and will be ignored + required: true + validation: + warnings: + - field: LineItems + details: Only one line is supported + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + validation: + warnings: [] + information: + - field: Payment.CurrencyRate + details: is not supported and will be ignored + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + validation: + warnings: [] + information: + - field: Payment.PaidOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: is not supported and will be ignored + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.CurrencyRate + details: is not supported and will be ignored + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.AllocatedOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: is not supported and will be ignored + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Only one line is supported + information: [] + required: true + FreeAgent: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + id: + type: String + displayName: Unique Direct Transaction ID + description: 'The identifier for the direct transaction, unique to the company' + required: false + validation: + warnings: + - field: Id + details: 'will be ignored on push. ' + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: 'is not supported by FreeAgent and will not be mapped. ' + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: must be provided + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + validation: + warnings: + - field: ContactRef.Id + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: false + validation: + warnings: + - field: ContactRef.DataType + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: must be provided + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: + - field: CurrencyRate + details: 'will be ignored on push. ' + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: 'If a Note is provided, this field will be ignored on push. ' + information: [] + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: + - field: LineItems.UnitAmount + details: 'will be ignored on push. ' + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Quantity + details: 'will be ignored on push. ' + information: [] + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: 'will be ignored on push. ' + information: [] + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: + - field: TaxRateRef.Name + details: 'will be ignored on push. ' + information: [] + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: + - field: TaxRateRef.EffectiveTaxRate + details: 'will be ignored on push. ' + information: [] + required: false + required: true + validation: + warnings: + - field: LineItems + details: Exactly one line item must be specified + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: false + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: false + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + required: false + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + validation: + warnings: + - field: ModifiedDate + details: 'will be ignored on push. ' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + validation: + warnings: + - field: SourceModifiedDate + details: 'will be ignored on push. ' + information: [] + required: true + Oracle NetSuite: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Should have the same sign across all line items + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Should not be a bank account + - field: LineItems.AccountRef + details: Should only be specified when pushing an expense + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Should only be specified when pushing an item (not an expense) + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Should be specified when item type is not 'Discount' + information: [] + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + required: false + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Credit Card' + information: [] + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Represents the check number + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: + - field: Note + details: Max length of 4096 characters. + information: [] + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: The account in which to make the deposit + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + validation: + warnings: [] + information: + - field: Payment.Reference + details: Use to reference the check number of this deposit. + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must contain a single payment allocation + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + Sage 50 (UK): + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: The user reference for this direct cost. + required: false + issueDate: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + currency: + type: String + displayName: Currency + description: The currency in which the direct cost is issued in. + required: true + validation: + warnings: + - field: currency + details: This must match the target account's default currency. + information: [] + currencyRate: + type: Number + displayName: Currency Rate + description: The currency rate associated with this transaction. + required: true + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this direct cost from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + subTotal: + type: Number + displayName: Sub Total + description: The net amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line net amounts + taxAmount: + type: Number + displayName: Tax Amount + description: The tax amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line tax amounts + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + lineItems: + type: Array + displayName: Line Items + description: Line items of the direct cost. + properties: + description: + type: String + displayName: description + description: Description of the direct cost line item. + required: false + accountRef: + type: Object + displayName: Nominal Code + description: Target bank account for the direct cost line item. + properties: + id: + type: String + displayName: Id + description: The ID of the Account the line is linked to. + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: Unit amount for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.unitAmount + details: Cannot equal 0 and will be set to Net amount if not provided accordingly. + information: [] + quantity: + type: Number + displayName: Quantity + description: Quantity for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.quantity + details: Must be 1 or -1. + information: [] + subTotal: + type: Number + displayName: Net Amount + description: 'Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.' + required: true + validation: + warnings: + - field: LineItems.subTotal + details: Cannot have both subtotal and tax amount as 0 for line item. + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: Tax amount for the direct cost line item. + required: false + validation: + warnings: + - field: LineItems.taxAmount + details: Cannot have both tax amount and subtotal as 0 for line item. + information: [] + totalAmount: + type: Number + displayName: Total Amount + description: Total amount for the direct cost line item. + required: false + validation: + warnings: [] + information: + - field: LineItems.totalAmount + details: Will be auto populated using tax amount and net amount. + taxCode: + type: Number + displayName: Tax Code Id + description: The tax code ID associated with this transaction. + required: true + trackingCategoryRefs: + type: Object + displayName: Tracking Category References + description: Tracking categories associated with this transaction. + properties: + id: + type: String + displayName: Id + description: The ID of the tracking category associated with the transaction + required: true + validation: + warnings: + - field: id + details: 'A department is required. If a project reference is provided, the cost code for that project must also be provided.' + information: [] + required: true + required: true + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Intacct: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: Must be used to provide payee's name and contain no more than 80 characters. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: Must be an existing tax rate in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not contain no more than 1000 characters. + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: false + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must contain at least one line item. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail. + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not contain no more than 45 characters. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: true + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: true + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: true + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + name: + type: String + displayName: Name + description: The name of the item referenced by the identifier + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + tracking: + type: Object + displayName: Tracking + description: Information this item is being tracked against + properties: + recordRefs: + type: Array + displayName: Record References + description: A collection of records this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + invoiceTo: + type: Object + displayName: Invoice To + description: The entity the record should be invoiced to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + required: true + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: Must be provided. + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not exceed 255 characters. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + validation: + warnings: [] + information: + - field: TaxAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + validation: + warnings: [] + information: + - field: TotalAmount + details: Must be provided. + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must be a valid GUID. + - field: ContactRef.Id + details: Must match the ID of an existing contact. + information: + - field: ContactRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: ContactRef + details: Must be provided. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a bank account. + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Payment + details: Must be provided. + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + validation: + warnings: + - field: Allocation.TotalAmount + details: Must be equal to the sum of line items. + information: + - field: Allocation.TotalAmount + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Allocation + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must be provided. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not be longer than 4000 characters long. + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: Must be provided. + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: + - field: LineItems.TotalAmount + details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: + - field: LineItems.TotalAmount + details: 'When one line is negative, all lines must be negative.' + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: LineItems.AccountRef + details: Must be provided. + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: [] + information: + - field: TrackingCategoryRefs.Id + details: Must be provided. + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: Tracking categories must not have the same parent tracking category. + - field: LineItems.TrackingCategoryRefs + details: Maximum of 2 Tracking Categories. + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: Must match the ID of an existing tax rate. + information: + - field: TaxRateRef.Id + details: 'If not provided, will be set to the default tax rate for the line''s account.' + required: false + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: false + validation: + warnings: + - field: ItemRef.Id + details: Must be a valid GUID. + - field: ItemRef.Id + details: Must match the ID of an existing item. + information: [] + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must be provided. + required: true + validation: + warnings: + - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: [] + Zoho Books: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Should be provided when SubTotal is not provided + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Should be provided when TotalAmount is not provided + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Is required when pushing a negative direct cost + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: Is required when pushing a negative direct cost + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: Is required when pushing a negative direct cost + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-directCosts-model + x-speakeasy-group: loan-writeback.direct-costs + description: | + The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create direct cost + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + examples: + QuickBooks Desktop: + value: + reference: test ref + note: directCost 21/03 09.20 + contactRef: + id: 80000001-1671793885 + dataType: suppliers + issueDate: '2023-03-21T10:19:52.223Z' + currency: USD + lineItems: + - description: test description line 1 + unitAmount: 7 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 99 + taxAmount: 360 + totalAmount: 70 + accountRef: + id: 8000000D-1671793811 + name: Purchases - Hardware for Resale + itemRef: + id: 80000001-1674566705 + name: item test + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + paymentAllocations: + - payment: + note: payment allocations note + reference: payment allocations reference + accountRef: + id: 80000028-1671794219 + name: Bank Account 1 + paidOnDate: '2023-01-28T10:19:52.223Z' + totalAmount: 54 + allocation: + currencyRate: 0 + allocatedOnDate: '2023-01-29T10:19:52.223Z' + totalAmount: 88 + subTotal: 362 + taxAmount: 4 + totalAmount: 366 + Xero: + value: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25' + currency: GBP + lineItems: + - description: negative direct cost + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + taxRateRef: + id: INPUT2 + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + allocation: + totalAmount: -42 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + FreeAgent: + value: + issueDate: '2023-02-12' + currency: GBP + lineItems: + - unitAmount: 15 + quantity: 1 + subTotal: 15 + accountRef: + id: '288' + paymentAllocations: + - payment: + accountRef: + id: 750-1 + allocation: {} + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + Sage Intacct: + value: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateDirectCostResponse' + examples: + FreeAgent: + value: + changes: [] + data: + id: '372060709' + issueDate: '2023-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '288' + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '372060709' + accountRef: + id: 750-1 + currency: GBP + paidOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + allocation: + currency: GBP + allocatedOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + sourceModifiedDate: '2023-02-12T15:15:53Z' + dataType: directCosts + companyId: a23f79d6-7cc9-486c-b388-8ab88faea947 + pushOperationKey: 0659a24d-2b66-4979-971e-4b98c3ed7f61 + dataConnectionKey: 35e38cd5-66ea-41b8-b555-9efd5b792b68 + requestedOnUtc: '2023-02-12T15:15:51.1723204Z' + completedOnUtc: '2023-02-12T15:15:54.7161036Z' + status: Success + statusCode: 200 + Sage Intacct: + value: + changes: + - type: Created + recordRef: + dataType: directCosts + data: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + taxRateRef: + id: '95' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + dataType: directCosts + companyId: d7f743a9-1804-4116-8c8a-e606f7e2f66c + pushOperationKey: 0d74c1ad-00ad-4731-9e6e-98a86056959a + dataConnectionKey: fa139396-523a-4a58-bf2b-8da82c8a673f + requestedOnUtc: '2023-03-31T12:49:51.6503324Z' + status: Pending + statusCode: 202 + Xero: + value: + changes: [] + data: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25T00:00:00' + currency: GBP + lineItems: + - description: negative direct cost + taxRateRef: + id: INPUT2 + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + paidOnDate: '0001-01-01T00:00:00' + totalAmount: 0 + allocation: + totalAmount: -42 + subTotal: 0 + taxAmount: -7 + totalAmount: -42 + dataType: directCosts + companyId: b5efee61-3fab-4a5d-9247-de03d6eda6db + pushOperationKey: 33347930-fcc5-4f95-aa13-4a0f7291b559 + dataConnectionKey: 1e355304-4476-422e-95cb-fa2a6d47fab4 + requestedOnUtc: '2023-02-24T13:43:26.5109173Z' + status: Pending + validation: + errors: [] + warnings: [] + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). + operationId: create-direct-cost + x-speakeasy-group: loan-writeback.direct-costs + '/companies/{companyId}/connections/{connectionId}/options/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create payment model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + FreeAgent: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: [] + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must match the sum of the line amounts. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must match the sum of the link amounts. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Other + type: String + displayName: Other + required: false + required: true + required: true + required: true + validation: + warnings: + - field: Lines + details: Only one line may be specified + information: [] + required: true + FreshBooks: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: Payment Amount must not exceed Invoice Amount Due or available Customer Credit + - field: Lines.Links + details: Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount + information: [] + required: true + validation: + warnings: + - field: Lines + details: Only one line is supported + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + options: + - value: AED + type: Array + displayName: AED + required: false + - value: AFN + type: Array + displayName: AFN + required: false + - value: ALL + type: Array + displayName: ALL + required: false + - value: AMD + type: Array + displayName: AMD + required: false + - value: ANG + type: Array + displayName: ANG + required: false + - value: AOA + type: Array + displayName: AOA + required: false + - value: ARS + type: Array + displayName: ARS + required: false + - value: AUD + type: Array + displayName: AUD + required: false + - value: AWG + type: Array + displayName: AWG + required: false + - value: AZN + type: Array + displayName: AZN + required: false + - value: BAM + type: Array + displayName: BAM + required: false + - value: BBD + type: Array + displayName: BBD + required: false + - value: BDT + type: Array + displayName: BDT + required: false + - value: BGN + type: Array + displayName: BGN + required: false + - value: BHD + type: Array + displayName: BHD + required: false + - value: BIF + type: Array + displayName: BIF + required: false + - value: BMD + type: Array + displayName: BMD + required: false + - value: BND + type: Array + displayName: BND + required: false + - value: BOB + type: Array + displayName: BOB + required: false + - value: BRL + type: Array + displayName: BRL + required: false + - value: BSD + type: Array + displayName: BSD + required: false + - value: BTN + type: Array + displayName: BTN + required: false + - value: BWP + type: Array + displayName: BWP + required: false + - value: BYR + type: Array + displayName: BYR + required: false + - value: BZD + type: Array + displayName: BZD + required: false + - value: CAD + type: Array + displayName: CAD + required: false + - value: CDF + type: Array + displayName: CDF + required: false + - value: CHF + type: Array + displayName: CHF + required: false + - value: CLP + type: Array + displayName: CLP + required: false + - value: CNY + type: Array + displayName: CNY + required: false + - value: COP + type: Array + displayName: COP + required: false + - value: CRC + type: Array + displayName: CRC + required: false + - value: CUC + type: Array + displayName: CUC + required: false + - value: CUP + type: Array + displayName: CUP + required: false + - value: CVE + type: Array + displayName: CVE + required: false + - value: CZK + type: Array + displayName: CZK + required: false + - value: DJF + type: Array + displayName: DJF + required: false + - value: DKK + type: Array + displayName: DKK + required: false + - value: DOP + type: Array + displayName: DOP + required: false + - value: DZD + type: Array + displayName: DZD + required: false + - value: EGP + type: Array + displayName: EGP + required: false + - value: ERN + type: Array + displayName: ERN + required: false + - value: ETB + type: Array + displayName: ETB + required: false + - value: EUR + type: Array + displayName: EUR + required: false + - value: FJD + type: Array + displayName: FJD + required: false + - value: FKP + type: Array + displayName: FKP + required: false + - value: GBP + type: Array + displayName: GBP + required: false + - value: GEL + type: Array + displayName: GEL + required: false + - value: GGP + type: Array + displayName: GGP + required: false + - value: GHS + type: Array + displayName: GHS + required: false + - value: GIP + type: Array + displayName: GIP + required: false + - value: GMD + type: Array + displayName: GMD + required: false + - value: GNF + type: Array + displayName: GNF + required: false + - value: GTQ + type: Array + displayName: GTQ + required: false + - value: GYD + type: Array + displayName: GYD + required: false + - value: HKD + type: Array + displayName: HKD + required: false + - value: HNL + type: Array + displayName: HNL + required: false + - value: HRK + type: Array + displayName: HRK + required: false + - value: HTG + type: Array + displayName: HTG + required: false + - value: HUF + type: Array + displayName: HUF + required: false + - value: IDR + type: Array + displayName: IDR + required: false + - value: ILS + type: Array + displayName: ILS + required: false + - value: IMP + type: Array + displayName: IMP + required: false + - value: INR + type: Array + displayName: INR + required: false + - value: IQD + type: Array + displayName: IQD + required: false + - value: IRR + type: Array + displayName: IRR + required: false + - value: ISK + type: Array + displayName: ISK + required: false + - value: JEP + type: Array + displayName: JEP + required: false + - value: JMD + type: Array + displayName: JMD + required: false + - value: JOD + type: Array + displayName: JOD + required: false + - value: JPY + type: Array + displayName: JPY + required: false + - value: KES + type: Array + displayName: KES + required: false + - value: KGS + type: Array + displayName: KGS + required: false + - value: KHR + type: Array + displayName: KHR + required: false + - value: KMF + type: Array + displayName: KMF + required: false + - value: KPW + type: Array + displayName: KPW + required: false + - value: KRW + type: Array + displayName: KRW + required: false + - value: KWD + type: Array + displayName: KWD + required: false + - value: KYD + type: Array + displayName: KYD + required: false + - value: KZT + type: Array + displayName: KZT + required: false + - value: LAK + type: Array + displayName: LAK + required: false + - value: LBP + type: Array + displayName: LBP + required: false + - value: LKR + type: Array + displayName: LKR + required: false + - value: LRD + type: Array + displayName: LRD + required: false + - value: LSL + type: Array + displayName: LSL + required: false + - value: LYD + type: Array + displayName: LYD + required: false + - value: MAD + type: Array + displayName: MAD + required: false + - value: MDL + type: Array + displayName: MDL + required: false + - value: MGA + type: Array + displayName: MGA + required: false + - value: MKD + type: Array + displayName: MKD + required: false + - value: MMK + type: Array + displayName: MMK + required: false + - value: MNT + type: Array + displayName: MNT + required: false + - value: MOP + type: Array + displayName: MOP + required: false + - value: MRO + type: Array + displayName: MRO + required: false + - value: MUR + type: Array + displayName: MUR + required: false + - value: MVR + type: Array + displayName: MVR + required: false + - value: MWK + type: Array + displayName: MWK + required: false + - value: MXN + type: Array + displayName: MXN + required: false + - value: MYR + type: Array + displayName: MYR + required: false + - value: MZN + type: Array + displayName: MZN + required: false + - value: NAD + type: Array + displayName: NAD + required: false + - value: NGN + type: Array + displayName: NGN + required: false + - value: NIO + type: Array + displayName: NIO + required: false + - value: NOK + type: Array + displayName: NOK + required: false + - value: NPR + type: Array + displayName: NPR + required: false + - value: NZD + type: Array + displayName: NZD + required: false + - value: OMR + type: Array + displayName: OMR + required: false + - value: PAB + type: Array + displayName: PAB + required: false + - value: PEN + type: Array + displayName: PEN + required: false + - value: PGK + type: Array + displayName: PGK + required: false + - value: PHP + type: Array + displayName: PHP + required: false + - value: PKR + type: Array + displayName: PKR + required: false + - value: PLN + type: Array + displayName: PLN + required: false + - value: PYG + type: Array + displayName: PYG + required: false + - value: QAR + type: Array + displayName: QAR + required: false + - value: RON + type: Array + displayName: RON + required: false + - value: RSD + type: Array + displayName: RSD + required: false + - value: RUB + type: Array + displayName: RUB + required: false + - value: RWF + type: Array + displayName: RWF + required: false + - value: SAR + type: Array + displayName: SAR + required: false + - value: SBD + type: Array + displayName: SBD + required: false + - value: SCR + type: Array + displayName: SCR + required: false + - value: SDG + type: Array + displayName: SDG + required: false + - value: SEK + type: Array + displayName: SEK + required: false + - value: SGD + type: Array + displayName: SGD + required: false + - value: SHP + type: Array + displayName: SHP + required: false + - value: SLL + type: Array + displayName: SLL + required: false + - value: SOS + type: Array + displayName: SOS + required: false + - value: SPL + type: Array + displayName: SPL + required: false + - value: SRD + type: Array + displayName: SRD + required: false + - value: STD + type: Array + displayName: STD + required: false + - value: SVC + type: Array + displayName: SVC + required: false + - value: SYP + type: Array + displayName: SYP + required: false + - value: SZL + type: Array + displayName: SZL + required: false + - value: THB + type: Array + displayName: THB + required: false + - value: TJS + type: Array + displayName: TJS + required: false + - value: TMT + type: Array + displayName: TMT + required: false + - value: TND + type: Array + displayName: TND + required: false + - value: TOP + type: Array + displayName: TOP + required: false + - value: TRY + type: Array + displayName: TRY + required: false + - value: TTD + type: Array + displayName: TTD + required: false + - value: TVD + type: Array + displayName: TVD + required: false + - value: TWD + type: Array + displayName: TWD + required: false + - value: TZS + type: Array + displayName: TZS + required: false + - value: UAH + type: Array + displayName: UAH + required: false + - value: UGX + type: Array + displayName: UGX + required: false + - value: USD + type: Array + displayName: USD + required: false + - value: UYU + type: Array + displayName: UYU + required: false + - value: UZS + type: Array + displayName: UZS + required: false + - value: VEF + type: Array + displayName: VEF + required: false + - value: VND + type: Array + displayName: VND + required: false + - value: VUV + type: Array + displayName: VUV + required: false + - value: WST + type: Array + displayName: WST + required: false + - value: XAF + type: Array + displayName: XAF + required: false + - value: XCD + type: Array + displayName: XCD + required: false + - value: XDR + type: Array + displayName: XDR + required: false + - value: XOF + type: Array + displayName: XOF + required: false + - value: XPF + type: Array + displayName: XPF + required: false + - value: YER + type: Array + displayName: YER + required: false + - value: ZAR + type: Array + displayName: ZAR + required: false + - value: ZMW + type: Array + displayName: ZMW + required: false + - value: ZWD + type: Array + displayName: ZWD + required: false + required: false + validation: + warnings: + - field: Currency + details: Can be used for Payments on Account only + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing customer. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Precision must be maximum of two decimal places. + - field: TotalAmount + details: Must be greater than zero. + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not be greater than 8 characters long. + currency: + type: String + displayName: Currency + description: Currency of the payment + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Precision must be maximum of two decimal places. + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense') + information: [] + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be greater than zero + - field: TotalAmount + details: Must be provided and must be equal to the sum of the lines amounts + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: The id format should be 'location-' + information: + - field: Reference + details: This field can be used to provide a tracking category id (Location only) + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted' + information: [] + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing supplier. + information: [] + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing 'Bank' or 'Other Current Asset' account. + information: + - field: AccountRef.Id + details: Not required if total amount of the payment is 0. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: Max length of 20 characters. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code that matches the currency of the customer. + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must match the sum of amounts in the lines + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: + - field: Lines.Amount + details: Amount plus the sum of amounts in the links must equal 0 + information: [] + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + validation: + warnings: + - field: Links.Type + details: 'Only 1 link with type ''PaymentOnAccount'' may be specified per line, this line may contain no other links' + - field: Links.Type + details: Only 1 link with type 'Invoice' may be specified per line + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this invoice from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + customerRef: + type: Object + displayName: Customer + description: Customer to be paid. + properties: + id: + type: String + displayName: Customer Id + description: Identifier of the customer. + required: true + validation: + warnings: + - field: customerRef.id + details: Must match the ID of an existing customer and have a max length of 8 characters. + information: [] + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid to the customer. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + reference: + type: Number + displayName: Reference + description: The user reference for this invoice payment. + required: false + date: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + note: + type: Number + displayName: Note + description: A description of the payment. + required: false + lines: + type: Array + displayName: Line Items + description: Line items of the payment. + properties: + amount: + type: Number + displayName: Amount + description: The amount of this line item + required: true + validation: + warnings: [] + information: + - details: this must equal the negative of the sum of the link amounts + links: + type: Array + displayName: Links + description: Links to the invoice being paid. + properties: + amount: + type: Number + displayName: Amount + description: The amount to be added to the value of the invoice + required: true + validation: + warnings: [] + information: + - details: 'When paying off an invoice, this value will be negative' + id: + type: String + displayName: Invoice Id + description: The ID of the invoice to pay + required: true + type: + type: String + displayName: Payment Link Type + description: The type of the item to be paid + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + required: true + required: true + validation: + warnings: [] + information: + - details: Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response. + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing Account. + information: + - field: AccountRef.Id + details: Must be provided. + required: false + validation: + warnings: + - field: AccountRef + details: Required unless the Payment is only allocating a Credit Note. + information: [] + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing Customer. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be zero when allocating against Invoices using a Credit Note only. + - field: TotalAmount + details: Must equal the sum of the link items amount. + information: + - field: TotalAmount + details: Must be provided. + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + validation: + warnings: + - field: Note + details: Should not be longer than 25 characters. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If supplied, must match the currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: Must be greater than zero except when Type is Invoice + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: PaymentOnAccount + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: [] + information: + - field: TotalAmount + details: Must equal the sum of Lines.Amount. + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + validation: + warnings: [] + information: + - field: Note + details: Must be less than 1000 characters. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + options: + - value: '1' + type: String + displayName: Printed Check + required: false + - value: '3' + type: String + displayName: Credit Card + required: false + - value: '5' + type: String + displayName: EFT + required: false + - value: '6' + type: String + displayName: Cash + required: false + required: true + required: true + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: [] + information: + - field: Reference + details: Can be used to set the Document/Check No. in Sage Intacct. + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Is required if currency is provided. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must occur after the date the invoice was created. + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: [] + information: + - field: CustomerRef.Id + details: Must be an existing customer ID in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: For undeposited payments use the GL account record number to charge. + - field: AccountRef.Id + details: 'To charge either a savings, checking or credit card account use its associated GL account number.' + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: When added together with the sum of the Links.Amount the total must be zero. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: 'Must be a valid Record No. from accounts receivable of either an invoice for an ''Invoice'', adjustment for a ''CreditNote'' or an advance for a ''PaymentOnAccount'' in Sage Intacct.' + - field: Links.Id + details: Must be an integer. + - field: Links.Id + details: Must related to CustomerRef.Id in Sage Intacct. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be one of Invoiceor CreditNoteor PaymentOnAccount. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must not be more than the total amount due for an invoice or the available funds in the account to be charged. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount. + - field: Lines.Links + details: Must contain only one Invoice. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must contain at least one payment line. + required: true + validation: + warnings: [] + information: + - details: Sage Intacct handles allocated payments only. + Sandbox: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + companyName: + type: String + displayName: Name + description: The name of the customer referenced by the identifier + required: true + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + name: + type: String + displayName: Name + description: The name of the payment method referenced by the identifier + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the currency of the linked transaction + required: true + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + required: true + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing account. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be either a type of BANK account or enable payments must be switched on. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: 'Must be greater than 0, unless the payment is a credit note allocation.' + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: Must be a valid GUID. + information: + - field: Links.Id + details: Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice. + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. + required: true + Zoho Books: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: AccountRef.ID is required when making a payment to an invoice and/or a payment on account + information: [] + required: true + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + validation: + warnings: + - field: Currency + details: must match the currency of any invoices or credit notes + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: must be greater than or equal to 0 + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: the sum of all link amounts must equal the negated total amount of the payment + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - type: Array + displayName: Invoice + required: false + - type: Array + displayName: CreditNote + required: false + - type: Array + displayName: PaymentOnAccount + required: false + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: 'if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed' + information: [] + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-payment-model + x-speakeasy-group: loan-writeback.payments + description: |- + The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create payment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + QuickBooks Desktop: + value: + customerRef: + id: 80000002-1674552702 + companyName: string + accountRef: + id: '8000002E-1675267199' + name: Undeposited Funds + paymentMethodRef: + id: string + name: string + totalAmount: 28 + currency: USD + currencyRate: 1 + date: '2023-02-10T11:47:04.792Z' + note: note 14/02 1147 + lines: + - amount: 28 + links: + - type: Invoice + id: 181-1676374586 + amount: -28 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref 14/02 1147 + Sage 50 (UK): + value: + customerRef: + id: CUST1 + accountRef: + id: '1200' + name: Bank Current Account + paymentMethodRef: + id: '4405' + totalAmount: 4 + currency: GBP + currencyRate: 1 + date: '2023-03-17T11:47:04.792Z' + note: note 07/03 14.31 + lines: + - amount: 4 + links: + - type: Invoice + id: INV-31 + amount: -4 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref + Sage Business Cloud Accounting: + value: + customerRef: + id: 30444c5bd4964fd787c7f8e2e5301ce1 + companyName: Stanley test customer + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 0.17 + currency: GBP + currencyRate: 1 + date: '2023-03-20T11:47:04.792Z' + note: Need to send products asap. + lines: + - amount: 0.17 + links: + - type: Invoice + id: bb85db9226d7450fb99eb83e7fb37505 + amount: -0.17 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: normal payment 20/03 17.05 + Sage Intacct: + value: + customerRef: + id: '19' + accountRef: + id: '81' + date: '2022-03-12T00:00:00' + totalAmount: 0 + lines: + - amount: 0 + links: + - id: '246' + type: Invoice + amount: -1.1 + - id: '280' + type: CreditNote + amount: 1.1 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreatePaymentResponse' + examples: + Sage Intacct: + value: + data: + customerRef: + id: '19' + accountRef: + id: '81' + totalAmount: 0 + date: '2022-03-12T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '246' + amount: -1.1 + - type: CreditNote + id: '280' + amount: 1.1 + dataType: payments + companyId: ffa6368e-fde4-4165-9a0a-4bda1a6f916e + pushOperationKey: 673f5d97-1c53-41ef-b9c8-cc9a8415d17c + dataConnectionKey: bbecdbf3-913a-43ae-9c91-e830b3686657 + requestedOnUtc: '0001-01-01T00:00:00' + status: Pending + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). + operationId: create-payment + x-speakeasy-group: loan-writeback.payments + '/companies/{companyId}/push/{pushOperationKey}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/pushOperationKey' + get: + summary: Get create operation + tags: + - Loan writeback + operationId: get-create-operation + x-speakeasy-group: loan-writeback.create-operations + description: Retrieve create operation. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/push': + parameters: + - $ref: '#/components/parameters/companyId' + get: + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + summary: List create operations + tags: + - Loan writeback + operationId: list-create-operations + x-speakeasy-group: loan-writeback.create-operations + description: List create operations. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperations' + examples: {} + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/configuration': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + summary: Get upload configuration + description: |- + Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection. + + With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements. + + When you use the [*Upload data*](https://docs.codat.io/lending-api#/operations/upload-bank-statement-data) endpoint next, you must upload the data for the account you configured. + operationId: get-bank-statement-upload-configuration + x-speakeasy-name-override: get-upload-configuration + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + tags: + - Bank statements + summary: Set upload configuration + description: |- + Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection. + + With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements. + + Each data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. + operationId: set-bank-statement-upload-configuration + x-speakeasy-name-override: set-upload-configuration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/startSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Bank statements + summary: Start upload session + description: |- + Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company. + + A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + + You can only have one active session per data type at a time. You can complete or cancel a session using the [*End upload session*](https://docs.codat.io/lending-api#/operations/end-bank-statement-upload-session) endpoint. + operationId: start-bank-statement-upload-session + x-speakeasy-name-override: start-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartUploadSessionRequest' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/upload': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + - $ref: '#/components/parameters/path' + post: + tags: + - Bank statements + summary: Upload data + description: |- + During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session. + + Make sure you created configuration for the account using the [*Set upload configuration*](https://docs.codat.io/lending-api#/operations/set-bank-statement-upload-configuration) endpoint before attempting an upload. + operationId: upload-bank-statement-data + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/BankingTransactions' + - $ref: '#/components/schemas/ThirdPartySchema' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/endSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + post: + tags: + - Bank statements + summary: End upload session + description: |- + Use the *End upload session* endpoint to finalize a bank statement upload session. Include a `status` in the request body to indicate if you want to cancel the processing of the dataset or trigger the ingestion and enrichment of the data. + + A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + operationId: end-bank-statement-upload-session + x-speakeasy-name-override: end-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EndUploadSessionRequest' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/{reportType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + post: + tags: + - Manage reports + summary: Generate report + description: |- + Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter. + + This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. + operationId: generate-report + x-speakeasy-name-override: generate-report + responses: + '202': + description: Accepted (pending) + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/{reportType}/{reportId}/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Manage reports + summary: Get report status + description: |+ + Use the *Get report status* endpoint to return the metadata about report generation, such as its current status, date of request, and date of generation. + + You can either provide the ID of a report or use `latest` as the ID value to get the most recent generated *reportName* report for the company. + + operationId: get-report-status + x-speakeasy-name-override: get-report-status + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: Get categorized bank statement transactions + description: |- + The *Get categorized bank statement transactions* endpoint returns fully categorized bank transactions for a company. Transaction data is obtained from the company's connected bank accounts. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: get-categorized-bank-statement-transactions + x-speakeasy-name-override: get-categorized-bank-statement-transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementTransactions' + example: + pageNumber: 1 + pageSize: 100 + totalResults: 2194 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + results: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: null + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: null + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: List categorized bank statement accounts + description: |- + The *Get categorized bank statement accounts* endpoint returns a list of bank accounts associated with categorized transactions for a company. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: list-categorized-bank-statement-accounts + x-speakeasy-name-override: list-categorized-bank-statement-accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementAccounts' + example: + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=10 + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Bank statements + summary: Download categorized bank statement Excel + description: |- + Use the *Download categorized bank statement Excel* endpoint to download the categorized bank statement Excel file. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: download-categorized-bank-statement-excel + x-speakeasy-name-override: download-categorized-bank-statement-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Financial summary + summary: Download credit model Excel + description: |- + > **Available as beta release** + > + > This endpoint is part of a beta release. Please contact your account manager if you want to enable it. + + Use the *Download Credit Model Excel* endpoint to download the credit model Excel file. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`. + operationId: download-credit-model-excel + x-speakeasy-name-override: download-credit-model-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Manage reports + summary: List reports + description: 'Use the *List reports* endpoint to return details (such as generation''s current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results.' + operationId: list-reports + x-speakeasy-name-override: list-reports + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation/definitions/reports' + example: + pageNumber: 1 + pageSize: 4 + totalResults: 15 + _links: + self: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports + current: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=1&pageSize=4 + next: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=2&pageSize=4 + results: + - id: c0d52c82-777f-4309-81a0-d935aea0562b + status: InProgress + type: categorizedBankStatement + requested: '2024-10-15T07:00:00Z' + updated: '2024-10-15T15:31:45Z' + - id: 79ef0451-edbd-4108-82ff-0b991444f1ec + status: Complete + type: categorizedBankStatement + requested: '2024-09-10T05:50:00Z' + updated: '2024-09-11T14:37:12Z' + - id: ae125b45-ed37-4bb4-bb4a-d55383fd56b2 + status: Complete + type: categorizedBankStatement + requested: '2024-09-06T07:47:10Z' + updated: '2024-09-20T14:42:15Z' + - id: ebfaf90c-31fe-407f-a016-bc2b3e60894a + status: Error + type: categorizedBankStatement + requested: '2024-07-15T04:45:14Z' + updated: '2024-07-15T17:41:45Z' + errorMessage: Failed to generate the report because.... + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/financialSummary': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + get: + tags: + - Financial summary + summary: Get financial summary insights + description: |- + > **Available as beta release** + > + > This endpoint is part of a beta release. Please contact your account manager if you want to enable it. + + Financial summary insights provide high-level indicators about the accuracy and completeness of a business’s financial data. These insights include: + - Closed Books Indicator – An estimate of the most recent accounting period officially closed by a business + - Accounting Score – An evaluation of the quality and completeness of a business’s bookkeeping + + Before accessing this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`. + + > Please note that missing elements might be disabled for the account. Please contact account manager for more details. + operationId: get-financial-summary + x-speakeasy-name-override: get-financial-summary + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FinancialSummary' + example: + booksClosedDate: + date: '2025-05-31T00:00:00Z' + reason: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + score: 90 + reason: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + '204': + description: No content + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' +webhooks: + Account categories updated: + post: + requestBody: + description: Triggered when a company's accounts are categorized. + content: + application/json: + schema: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reached: + post: + description: Called when your client’s request count to Codat's API surpasses the allocated quota. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reached: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reached + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 0 + expiryDate: '2024-09-01T12:14:14Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reset: + post: + description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reset: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reset + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 11993 + expiryDate: '2024-09-01T23:59:99Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.successful: + post: + description: Called when a categorized bank statement is successfully generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.unsuccessful: + post: + description: Called when a categorized bank statement has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.successful: + post: + description: Called when a credit model report is successfully generated. + requestBody: + content: + application/json: + schema: + title: Report generation webhook + type: object + properties: + id: + type: string + format: uuid + example: ba29118f-5406-4e59-b05c-ba307ca38d01 + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - reports.categorizedBankStatement.generate.successful + - reports.creditModel.generate.successful + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema/definitions/ReportGenerationPayload' + definitions: + ReportGenerationPayload: + title: Report generation payload + type: object + properties: + id: + type: string + format: uuid + example: a78e2625-7190-4d94-ae3b-071320451026 + description: Unique identifier of the report. + referenceCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.unsuccessful: + post: + description: Called when a credit model report has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + AccountCategoriesUpdatedWebhook: + title: Account categories updated webhook + description: Webhook request body for the "Account categories updated" event. + x-internal: true + type: object + properties: + ClientId: + title: Client ID + type: string + format: uuid + description: Unique identifier for your client in Codat. + ClientName: + type: string + description: Name of your client in Codat. + CompanyId: + $ref: '#/components/parameters/companyId/schema' + DataConnectionId: + $ref: '#/components/parameters/connectionId/schema' + RuleId: + type: string + format: uuid + description: Unique identifier for the rule. + deprecated: true + RuleType: + type: string + x-stoplight: + id: 34d52a089f08a + description: The type of rule. + AlertId: + type: string + format: uuid + description: Unique identifier of the webhook event. + Message: + type: string + description: A human-readable message about the webhook. + Data: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook/definitions/AccountCategoriesUpdatedWebhookData' + definitions: + AccountCategoriesUpdatedWebhookData: + type: object + title: Account categories updated webhook data + properties: + modifiedDate: + $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' + description: The date on which the company's account categories were last modified in Codat. + examples: + - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + ClientName: Bank of Dave + CompanyId: 8a210b68-6988-11ed-a1eb-0242ac120002 + DataConnectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac + RuleType: Account Categories Updated + AlertId: a9367074-b5c3-42c4-9be4-be129f43577e + Message: Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968. + Data: + modifiedDate: '2019-08-24T14:15:22Z' + AccountingAccount: + title: 'Accounting: Account' + description: "\uFEFF> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\n## Overview\n\nAccounts 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.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model).\n- Refer to the integration's own documentation.\n\n> **Accounts with no category**\n>\n> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.\n>\n> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports." + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + - $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountPrototype: + title: Account prototype + type: object + properties: + nominalCode: + type: string + nullable: true + description: 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. + example: '610' + name: + type: string + nullable: true + description: Name of the account. + example: Accounts Receivable + description: + type: string + nullable: true + description: Description for the account. + example: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: + type: string + nullable: true + description: "Full category of the account. \r\n\r\nFor 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." + example: Asset.Current + fullyQualifiedName: + type: string + nullable: true + description: |- + Full name of the account, for example: + - `Cash On Hand` + - `Rents Held In Trust` + - `Fixed Asset` + examples: + - Cash On Hand + - Fixed Asset + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currentBalance: + type: number + format: decimal + nullable: true + description: Current balance in the account. + example: 0 + type: + $ref: '#/components/schemas/AccountingAccount/definitions/accountType' + status: + $ref: '#/components/schemas/AccountingAccount/definitions/accountStatus' + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validDatatypeLinks: + type: array + nullable: true + description: '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](/lending-api#/schemas/ValidDataTypeLinks).' + items: + title: Valid data type links + description: |- + When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data. + + For example, `validDatatypeLinks` might indicate the following references: + + - Which tax rates are valid to use on the line item of a bill. + - Which items can be used when creating an invoice. + + You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example. + + ## `validDatatypeLinks` example + + The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error. + + ```json validDatatypeLinks for an account + { + "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", + "nominalCode": "090", + "name": "Business Bank Account", + #... + "validDatatypeLinks": [ + { + "property": "Id", + "links": [ + "Payment.AccountRef.Id", + "BillPayment.AccountRef.Id", + "DirectIncome.LineItems.AccountRef.Id", + "DirectCost.LineItems.AccountRef.Id" + ] + } + ] + } + ``` + + + + ## Support for `validDatatypeLinks` + + Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. + + If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. + type: object + properties: + property: + type: string + nullable: true + description: The property from the account that can be linked. + links: + type: array + nullable: true + description: Supported `dataTypes` that the record can be linked to. + items: + type: string + supplementalData: + $ref: '#/components/schemas/SupplementalData' + accountRef: + title: Account reference + type: object + description: 'Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.' + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + name: + type: string + description: '''name'' from the Accounts data type.' + accountType: + title: Account type + enum: + - Unknown + - Asset + - Expense + - Income + - Liability + - Equity + type: string + description: Type of account + example: Asset + accountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the account + example: Active + type: object + AccountingAccounts: + title: 'Accounting: Accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingAccountTransaction: + title: 'Accounting: Account transaction' + description: |- + > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions). + + ## Overview + + In Codat’s data model, account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Account transactions are created as a result of different business activities, for example: + + * Payments: for example, receiving money for payment against an invoice. + * Bill payments: for example, spending money for a payment against a bill. + * Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment. + * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale. + * Transfers: for example, transferring money between two bank accounts. + + Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier of the direct cost (unique to the company). + transactionId: + type: string + nullable: true + description: Identifier of the transaction (unique to the company). + note: + type: string + nullable: true + description: 'Additional information about the account transaction, if available.' + bankAccountRef: + $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountRef' + description: Reference to the bank account the account transaction is recorded against. + date: + $ref: '#/components/schemas/DateTime' + description: The date the account transaction was recorded in the platform. + status: + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + type: string + description: The status of the account transaction. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lines: + type: array + nullable: true + description: Array of account transaction lines. + items: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLine' + totalAmount: + type: number + format: decimal + description: 'Total amount of the account transactions, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountTransactionLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the account transaction. + recordRef: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLineRecordRef' + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + accountTransactionLineRecordRef: + type: object + title: Record reference + description: Links an account transaction line to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingAccountTransactions: + title: 'Accounting: Account transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccountTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingAddress: + title: 'Accounting: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/AccountingAddress/definitions/accountingAddressType' + line1: + type: string + nullable: true + description: Line 1 of the customer address. + line2: + type: string + nullable: true + description: Line 2 of the customer address. + city: + type: string + nullable: true + description: City of the customer address. + region: + type: string + nullable: true + description: Region of the customer address. + country: + type: string + nullable: true + description: Country of the customer address. + postalCode: + type: string + nullable: true + description: Postal code or zip code. + required: + - type + definitions: + accountingAddressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + AccountingAgedCreditorReport: + title: 'Accounting: Aged creditors report' + description: |- + The Aged Creditors report shows the total balance owed by a business to its suppliers over time. + + You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal. + + Total assets or liabilities are grouped into 30-day periods for each supplier, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency. + + > It is not guaranteed that write-offs are included in the Aged Creditors report. + + ## Underlying data + + The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). + + To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. + + > The Aged Creditor report runs based on the **issue dates** of the underlying data types rather than the due date. + + ## Accessing the Aged Creditors report in Portal + + Apart from returning the report via the API as JSON and query, you can also return the Aged Creditors report in the Codat portal. + + 1. In the navigation bar, click **Companies**. + 2. Click the name of the company you want to generate the report for. The company's data page is displayed. + 3. Click the **Accounting** tab then click **Reports**. + 4. Select **Aged Creditors**. + 5. _(Optional)_ Edit the default reporting parameters. + a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. + b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days). + b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods). + 6. To run the report, click **Load aged creditors**. + 7. The report is generated and displayed at the bottom of the page. + + The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes. + type: object + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged creditor. + items: + $ref: '#/components/schemas/AccountingAgedCreditorReport/definitions/agedCreditor' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Bills + amount: 1547.5 + definitions: + agedCreditor: + title: Aged creditor + type: object + properties: + supplierId: + type: string + description: Supplier ID of the aged creditor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + supplierName: + type: string + description: Supplier name of the aged creditor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged creditors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + AccountingAgedDebtorReport: + type: object + title: 'Accounting: Aged debtors report' + description: |- + The Aged Debtors report shows the total outstanding balance due from customers to the business over time. + + You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal. + + Total assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency. + + > It is not guaranteed that write-offs are included in the Aged Debtors report. + + ## Underlying data + + The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). + + To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. + + > The Aged Debtors report runs based on the **issue dates** of the underlying data types rather than the due date. + + ## Accessing the Aged Debtors report in Portal + + Apart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal. + + 1. In the navigation bar, click **Companies**. + 2. Click the name of the company you want to generate the report for. The company's data page is displayed. + 3. Click the **Accounting** tab then click **Reports**. + 4. Select **Aged Debtors**. + 5. _(Optional)_ Edit the default reporting parameters. + a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. + b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days). + b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods). + 6. To run the report, click **Load aged debtors**. + 7. The report is generated and displayed at the bottom of the page. + + The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes. + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged debtors. + items: + $ref: '#/components/schemas/AccountingAgedDebtorReport/definitions/agedDebtor' + definitions: + agedDebtor: + title: Aged debtor + type: object + properties: + customerId: + type: string + description: Customer ID of the aged debtor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: + type: string + description: Customer name of the aged debtor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged debtors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Invoices + amount: 1547.5 + AccountingAttachment: + title: 'Accounting: Attachment' + description: | + The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes. + + > **Retrieving attachments** + > + > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data. + + Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. + + Note that different integrations have different requirements to file size and extension of attachments. + + | Integration | File size | File extension | + |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| + | Xero | 4 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 | + | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | + | NetSuite | 100 MB | 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". | + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the attachment, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the attachment file. + contentType: + type: string + nullable: true + description: |- + File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**. + + Supported file types vary per platform. + dateCreated: + $ref: '#/components/schemas/DateTime' + fileSize: + type: integer + format: int32 + nullable: true + description: 'File size in bytes. For example, if this reads **46153**, then the file size is 46kb.' + includeWhenSent: + type: boolean + description: 'If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting software allows this.' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: [] + definitions: + attachments: + title: Attachments + type: object + properties: + attachments: + description: An array of attachments related to the record. + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + AccountingBalanceSheet: + title: 'Accounting: Balance sheet' + description: |- + ## Overview + + The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes. + + > **Balance sheet or profit and loss report?** + > + > A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time. + + **Structure of this report** + This report will reflect the structure and line descriptions that the business has set in their own accounting software. + + **History** + By default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings). + + **Want to pull this in a standardised structure?** + Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. + type: object + additionalProperties: false + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the balance sheet. + reports: + type: array + description: An array of balance sheet reports. + items: + $ref: '#/components/schemas/AccountingBalanceSheet/definitions/balanceSheet' + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Earliest available monthly report data. + required: + - reports + definitions: + balanceSheet: + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Point in time when a snapshot of a company's financial position is taken. + assets: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for assets. For example, fixed and current assets.' + liabilities: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for liabilities. For example, current liabilities.' + netAssets: + type: number + format: decimal + description: Value of net assets for a company in their base currency. + equity: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for equities. For example, retained and current year earnings. See below.' + required: + - netAssets + AccountingBankAccount: + title: 'Accounting: Bank account' + description: |- + > **Accessing Bank Accounts through Banking API** + > + > 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 [Banking: Account](https://docs.codat.io/lending-api#/schemas/Account) data type. + + ## Overview + + A list of bank accounts associated with a company and a specific data connection. + + Bank accounts data includes: + * The name and ID of the account in the accounting software. + * The currency and balance of the account. + * The sort code and account number. + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company in the accounting software.' + - $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + bankAccountPrototype: + title: Bank account prototype + type: object + properties: + accountName: + type: string + nullable: true + description: Name of the bank account in the accounting software. + accountType: + $ref: '#/components/schemas/AccountingBankAccountType' + nominalCode: + type: string + nullable: true + description: Code used to identify each nominal account for a business. + sortCode: + type: string + nullable: true + description: |- + 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. + accountNumber: + type: string + nullable: true + description: |- + 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. + iBan: + type: string + nullable: true + description: International bank account number of the account. Often used when making or receiving international payments. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Base currency of the bank account. + balance: + type: number + format: decimal + nullable: true + description: Balance of the bank account. + institution: + type: string + nullable: true + description: The institution of the bank account. + availableBalance: + type: number + format: decimal + nullable: true + description: 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. + overdraftLimit: + type: number + format: decimal + nullable: true + description: |- + 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`. + status: + $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountStatus' + bankAccountCreateResponse: + title: Create bank account response + allOf: + - properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + bankAccountRef: + title: Bank account reference + type: object + properties: + id: + type: string + description: Bank account 'id' for the account transaction. + name: + type: string + description: bank account 'name' for the account transaction. + description: Links to the Account transactions data type. + bankAccounts: + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + bankAccountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the bank account. + example: Active + AccountingBankAccounts: + x-internal: true + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingBankAccountType: + title: Bank Account Type + x-internal: true + enum: + - Unknown + - Credit + - Debit + type: string + description: |- + 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. + AccountingBankTransaction: + title: 'Accounting: Bank account transaction' + description: |- + > **Accessing Bank Accounts through Banking API** + > + > 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 [Banking: Transaction](https://docs.codat.io/lending-api#/operations/list-transactions) data type. + + ## Overview + + Transactional banking data for a specific company and account. + + Bank transactions include the: + * Amount of the transaction. + * Current account balance. + * Transaction type, for example, credit, debit, or transfer. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bank transaction, unique to the company in the accounting software.' + accountId: + type: string + nullable: true + description: Unique identifier to the `accountId` the bank transactions originates from. + clearedOnDate: + $ref: '#/components/schemas/DateTime' + description: + type: string + nullable: true + description: Description of the bank transaction. + reconciled: + type: boolean + description: '`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + transactionType: + $ref: '#/components/schemas/AccountingBankTransaction/definitions/bankTransactionType' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + bankTransactionType: + title: Bank transaction type + description: Type of transaction for the bank statement line. + type: string + enum: + - Unknown + - Credit + - Debit + - Int + - Div + - Fee + - SerChg + - Dep + - Atm + - Pos + - Xfer + - Check + - Payment + - Cash + - DirectDep + - DirectDebit + - RepeatPmt + - Other + AccountingBankTransactions: + title: 'Accounting: Accounting bank transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingBill: + title: 'Accounting: Bill' + description: |- + > **Invoices or bills?** + > + > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill. + > + > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills. + + ## Overview + + In Codat, a bill contains details of: + * When the bill was recorded in the accounting system. + * How much the bill is for and the currency of the amount. + * Who the bill was received from — the *supplier*. + * What the bill is for — the *line items*. + + Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*. + + You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: + type: string + nullable: true + description: User-friendly reference for the bill. + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + purchaseOrderRefs: + type: array + nullable: true + items: + title: Purchase order Reference + type: object + additionalProperties: false + properties: + id: + type: string + description: 'Identifier for the purchase order, unique for the company in the accounting software.' + purchaseOrderNumber: + type: string + nullable: true + description: 'Friendly reference for the purchase order, commonly generated by the accounting software.' + issueDate: + allOf: + - description: Date of the bill as recorded in the accounting software. + - $ref: '#/components/schemas/DateTime' + dueDate: + allOf: + - description: Date the supplier is due to be paid. + - $ref: '#/components/schemas/DateTime' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: Array of Bill line items. + items: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem' + withholdingTax: + type: array + nullable: true + items: + type: object + properties: + name: + minLength: 1 + type: string + description: Name assigned to withheld tax. + amount: + type: number + format: decimal + description: Amount of tax withheld. + required: + - amount + - name + status: + $ref: '#/components/schemas/AccountingBill/definitions/billStatus' + subTotal: + type: number + format: decimal + description: 'Total amount of the bill, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: Amount of tax on the bill. + totalAmount: + type: number + format: decimal + description: 'Amount of the bill, including tax.' + amountDue: + type: number + format: decimal + nullable: true + description: Amount outstanding on the bill. + note: + type: string + nullable: true + description: 'Any private, company notes about the bill, such as payment information.' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - status + - subTotal + - taxAmount + - totalAmount + definitions: + billStatus: + description: Current state of the bill. + type: string + enum: + - Unknown + - Open + - PartiallyPaid + - Paid + - Void + - Draft + billLineItem: + title: Bill line item + type: object + properties: + lineNumber: + type: string + nullable: true + description: The bill line's number. + description: + type: string + nullable: true + description: Friendly name of the goods or services received. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: |- + Numerical value of any discounts applied. + + Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the bill. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + nullable: true + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the line item is linked.' + purchaseOrderLineRef: + allOf: + - type: object + x-internal: true + title: Record line reference + description: |- + Links the current record line to the underlying record line that created it. + + For example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. + properties: + id: + type: string + description: '''id'' of the underlying record.' + dataType: + type: string + description: Allowed name of the 'dataType'. + enum: + - purchaseOrders + - bills + lineNumber: + type: string + description: Line number of the underlying record. + - description: Reference to the purchase order line this line was generated from. + trackingCategoryRefs: + type: array + nullable: true + description: Collection of categories against which this item is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + isDirectCost: + type: boolean + description: The bill is a direct cost if `True`. + AccountingBillCreditNote: + title: 'Accounting: Bill credit note' + description: |- + > **Bill credit notes or credit notes?** + > + > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). + + ## Overview + + A bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills. + + In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier). + + A bill credit note includes details of: + * The original and remaining credit. + * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill). + * The supplier that issued the bill credit note. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier for the bill credit note that is unique to a company in the accounting software. + example: 1509398f-98e2-436d-8a5d-c042e0c74ffc + billCreditNoteNumber: + type: string + nullable: true + description: Friendly reference for the bill credit note. + example: 91fe2a83-e161-4c21-929d-c5c10c4b07e5 + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: 'Total amount of credit that has been applied to the business'' account with the supplier, including discounts and tax.' + example: 805.78 + totalDiscount: + type: number + format: decimal + description: Total value of any discounts applied. + example: 0 + subTotal: + type: number + format: decimal + description: 'Total amount of the bill credit note, including discounts but excluding tax.' + example: 805.78 + totalTaxAmount: + type: number + format: decimal + description: Amount of tax included in the bill credit note. + example: 0 + discountPercentage: + type: number + format: decimal + description: Percentage rate of any discount applied to the bill credit note. + example: 0 + remainingCredit: + type: number + format: decimal + description: Amount of the bill credit note that is still outstanding. + example: 0 + status: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteStatus' + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date the bill credit note was issued by the supplier. + example: '2022-03-15T00:00:00' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Date the bill credit note was fully refunded or allocated. + example: '2022-09-15T16:35:00' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the bill credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: 'An array of line ' + items: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem' + paymentAllocations: + nullable: true + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + createdFromRefs: + nullable: true + type: array + description: An array of records the credit note was created from. + items: + $ref: '#/components/schemas/AccountingRecordRef' + note: + type: string + nullable: true + description: Any additional information about the bill credit note. + example: 'Bill Credit Note with 1 line items, totaling 805.78' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - status + definitions: + billCreditNoteStatus: + type: string + description: Current state of the bill credit note + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + example: Paid + billCreditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been received.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + title: Tax rate reference + type: object + description: |- + Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. + + Found on: + + - Bill line items + - Bill Credit Note line items + - Credit Note line items + - Direct incomes line items + - Invoice line items + - Items + properties: + id: + type: string + description: Unique identifier for the tax rate in the accounting software. + name: + type: string + description: Name of the tax rate in the accounting software. + effectiveTaxRate: + type: number + format: decimal + description: Applicable tax rate. + itemRef: + description: Reference to the item the line is linked to. + title: Item reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for the item in the accounting software. + name: + type: string + nullable: true + description: Name of the item in the accounting software. + required: + - id + createdFromLineRef: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem/properties/purchaseOrderLineRef/allOf/0' + description: Reference to the line of the item that the current line was created from. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + required: + - unitAmount + - quantity + examples: + - id: 6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d + billCreditNoteNumber: '14763237' + totalAmount: 693 + remainingCredit: 693 + status: Submitted + issueDate: '2019-02-18T16:03:07.268Z' + note: Track separately + currency: USD + lineItems: + - description: AcmeMagnet + unitAmount: 25 + discountAmount: 0 + quantity: 4 + subTotal: 100 + taxAmount: 10 + totalAmount: 110 + itemRef: + id: '3' + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + trackingCategoryRefs: + - id: department_1 + name: ACMERockets + - id: costcode_2 + name: ACM2-ACMESigns + createdFromLineRef: + - id: '8462' + dataType: bill + lineNumber: 1 + - description: ACMEDisintegratingPistol + unitAmount: 25 + discountAmount: 0 + quantity: 3 + subTotal: 75 + taxAmount: 7.5 + totalAmount: 82.5 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEWhippedCreamDispenser + unitAmount: 52 + discountAmount: 0 + quantity: 6 + subTotal: 312 + taxAmount: 31.2 + totalAmount: 343.2 + itemRef: + id: 3691f3d9-0ff7-4358-8a93-bed31c1b4b03 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEJetPropelledPogoStick + unitAmount: 130 + discountAmount: 0 + quantity: 1 + subTotal: 130 + taxAmount: 27.3 + totalAmount: 157.3 + itemRef: + id: 075410d4-7edc-4936-ba52-9e1e43cbe300 + taxRateRef: + id: d606732b-db18-44d7-823b-7f15f42c32ea + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + supplierRef: + id: 67C6A7A1-5E84-4AC4-B950-24A114E379D0 + supplierName: Chin's Gas and Oil + createdFromLineRef: + id: '8462' + dataType: bills + line: 1 + AccountingBillCreditNotes: + title: 'Accounting: Bill credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingBillPayment: + title: 'Accounting: Bill payment' + description: | + > **Bill payments or payments?** + > + > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment. + > + > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). + + ## Overview + + Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)). + + A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to: + + - A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment. + - An allocation of a supplier's credit note to a bill or perhaps a refund. + - A bill payment made directly to an accounts payable account. This could be an overpayment or a prepayment, or a refund of a payment made directly to an accounts payable account. + + Depending on the bill payments which are allowed by the underlying accounting software, some of these types may be combined. Please see the example data section for samples of what these cases look like. + + In Codat, a bill payment contains details of: + + - When the bill payment was recorded in the accounting system. + - How much it is for and in the currency. + - Who the payment has been paid to, the _supplier_. + - The types of bill payments, the _line items_. + + Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. + + Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + + --- + + ## Bill payment types + + ### Payment of a bill + + A payment paying a single bill should have the following properties: + + - A `totalAmount` indicating the amount of the bill that was paid. This is always positive. + - A `lines` array containing one element with the following properties: + - An `amount` equal to the `totalAmount` above. + - A `links` array containing one element with the following properties: + - A `type` indicating the type of link, in this case a `Bill`. + - An `id` containing the ID of the bill that was paid. + - An amount of `-totalAmount` (negative `totalAmount`), indicating that the entirety of the paid amount is allocated to the bill. + + ### Payment of multiple bills + + It is possible for one payment to pay multiple bills. This can be represented using two possible formats, depending on how the supplier keeps their books: + + 1. The payment has multiple entries in its **lines** array, one for each bill that is paid. Each line will follow the above example for paying a bill, and the rules detailed in the data model. + 2. The payment has a line with multiple links to each bill. This occurs when the proportion of the original payment allocated to each bill is not available. + + Each line is the same as those described above, with the **amount** indicating how much of the payment is allocated to the bill. The **amount** on the lines sum to the **totalAmount** on the payment. + + > Pushing batch payments to Xero + > + > When pushing a single bill payment to Xero to pay multiple bills, only the first format is supported—multiple entries in the payment **lines** array. + + ### Payments and refunds on account + + A payment on account, that is a payment that doesn’t pay a specific bill, has one entry in its lines array. + + The line has the following properties: + + - A **totalAmount** indicating the amount paid by a supplier or refunded to them by a company. A payment to the supplier is always negative. A refund is always positive. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`. + - The **id** containing the ID of the supplier. + - An amount for the link is `0` **totalAmount** or the amount of the payment or refund. + + It is possible to have a payment that is part on account and part allocated to a bill. Each line should follow the examples above. + + ### Using a credit note to pay a bill + + The payment of a bill using a credit note has one entry in its `lines` array. This **line** has the following properties: + + - An **amount** indicating the amount of money moved, which in this case is `0`, as the credit note and bill allocation must balance each other. + - A **links** array containing two elements: + - The first link has: + - A **type** indicating the type of link, in this case a `Bill`. + - An **id** containing the ID of the bill that was paid. + - The second link has: + - A **type** indicating the type of link, in this case a `CreditNote`. + - An **id** containing the ID of the credit note used by this payment. + + The **amount** field on the **line** equals the **totalAmount** on the payment. + + ### Refunding a credit note + + A bill payment refunding a credit note has one entry in its **lines** array. This line has the following properties: + + - An **amount** indicating the amount of the credit note that was refunded. This is always negative, indicating that it is a refund. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of `link`, in this case a `CreditNote`. + - An **id** containing the ID of the credit note that was refunded. + + The **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable. + + ### Refunding a payment + + If a payment is refunded, for example, when a company overpaid a bill and the overpayment is returned, there are two payment records: + + - One for the incoming overpayment. + - Another for the outgoing refund. + + The payment issuing the refund is identified by the fact that the **totalAmount** is negative. This payment has one entry in its lines array that have the following properties: + + - An **amount** indicating the amount that was refunded. This is always negative. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of a the link, in this case a `BillPayment`. + - An **id** containing the ID of the payment that was refunded. + + The **amount** field on the line equals the **totalAmount** on the payment and is negative as this is money leaving accounts payable. + + The payment that was refunded can be identified as it has a line where the `amount` on its `line` is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was partly used to pay an bill. For example, a £1,050 payment paying a £1,000 bill with a refund of £50 has two lines: + + - One for £1,000 linked to the bill that was paid + - Another for £50 linked to the payment that refunded the over payment. This link is of type `Refund` but the ID corresponds to a bill payment. + + The line linked to the bill payment has the following properties: + + - An **amount** indicating the amount that was refunded. This is positive as its money that was added to accounts payable, but is balanced out by the negative amount of the refund. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of the link, in this case a `Refund`. + - An **id** containing the ID of the payment that refunded this line. + + > Linked payments + > + > Not all accounting software support linked payments in this way. In these platforms you may see a payment on account and a refund on account. + + ## Foreign currencies + + There are two types of currency rate that are detailed in the bill payments data type: + + Payment currency rate: + + - Base currency of the accounts payable account. + - Foreign currency of the bill payment. + + Payment line link currency rate: + + - Base currency of the item that the link represents. + - Foreign currency of the payment. + + These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a bill payment is applied to an item in a currency that does not match either: + + - The base currency for the accounts payable account. + - The currency of the item. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + example: 3d5a8e00-d108-4045-8823-7f342676cffa + supplierRef: + allOf: + - $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + - description: Supplier against which the payment is recorded in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is linked to in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. + example: 1329.54 + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: ISO currency code in which the bill payment is recorded in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: Date the bill payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Additional information associated with the payment. + example: Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 + paymentMethodRef: + allOf: + - $ref: '#/components/schemas/PaymentMethodRef' + - description: The Payment Method to which the payment is linked in the accounting software. + lines: + type: array + nullable: true + description: An array of bill payment lines. + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLine' + reference: + type: string + nullable: true + description: Additional information associated with the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + billPaymentLine: + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: AllocatedOnDate must be specified and be later than the issue date of the bill. + required: + - amount + billPaymentLineLink: + type: object + properties: + type: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLinkType' + id: + type: string + nullable: true + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: |- + Amount by which the balance of the linked entity is altered, in the currency of the linked entity. + + - A negative link amount reduces the outstanding amount on the accounts payable account. + - A positive link amount increases the outstanding amount on the accounts payable account. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + billPaymentLineLinkType: + description: Types of links to bill payment lines. + type: string + enum: + - Unknown + - Unlinked + - Bill + - Other + - CreditNote + - BillPayment + - PaymentOnAccount + - Refund + - ManualJournal + - Discount + examples: + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: 2000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: 1000 + - totalAmount: 250 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -750 + - type: CreditNote + id: 'y' + amount: 750 + - amount: 250 + links: + - type: Bill + id: x + amount: -250 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - totalAmount: 2000 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: z + amount: 1000 + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: customer-001 + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: w + amount: -1000 + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - type: CreditNote + id: z + amount: 1000 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 4000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -4000 + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: Bill + id: 'y' + amount: -1000 + - amount: 3000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -3000 + - totalAmount: 500 + lines: + - amount: 500 + links: + - type: Bill + id: a + amount: -1000 + - type: Bill + id: b + amount: -1000 + - type: CreditNote + id: 'y' + amount: 750 + - type: CreditNote + id: z + amount: 750 + AccountingBillPayments: + title: 'Accounting: Bill payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingBills: + title: 'Accounting: Bills' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBill' + - $ref: '#/components/schemas/PagingInfo' + AccountingCashFlowStatement: + title: 'Accounting: Cash flow statement' + description: |- + > **Operating activities only** + > + > Currently, the cash flow statement shows cash that flows into and out of the company from operating activities *only*. Operating activities generate cash from the sale of goods or services. + + ## Overview + + A cash flow statement is a financial report that records all cash that is received or spent by a company during a given period. It gives you a clearer picture of the company’s performance, and their ability to pay creditors and finance growth. + + > **Cash flow statement or balance sheet?** + > + > Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees. + type: object + properties: + reports: + description: Array of cash flow statements. + type: array + items: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/cashFlowStatement' + reportBasis: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportBasis' + reportInput: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportInput' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of all values in the cash flow statement. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + required: + - reports + - reportBasis + - reportInput + definitions: + reportBasis: + title: Report basis + description: 'Accounting method used when aggregating the report data. In this case, `Cash`.' + type: string + enum: + - Unknown + - Accrual + - Cash + reportInput: + description: Accounting method used to prepare the cash flow statement. + type: string + enum: + - Unknown + - Indirect + - Direct + cashFlowStatement: + title: Cash flow statement + type: object + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date for the reporting period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date for the reporting period. + cashReceipts: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash receipts from the sale of goods. + cashPayments: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash payments to suppliers for the purchase of goods or services. + AccountingCompanyInfo: + title: 'Accounting: Company information' + description: |- + 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. + type: object + properties: + companyName: + type: string + nullable: true + description: Name of the linked company. + accountingPlatformRef: + type: string + nullable: true + description: Identifier or reference for the company in the accounting software. + companyLegalName: + type: string + nullable: true + description: Registered legal name of the linked company. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + phoneNumbers: + type: array + nullable: true + description: An array of phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + type: array + nullable: true + description: An array of weblinks. + items: + $ref: '#/components/schemas/WebLink' + ledgerLockDate: + $ref: '#/components/schemas/DateTime' + description: 'If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end.' + registrationNumber: + type: string + nullable: true + description: Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + taxNumber: + type: string + nullable: true + description: Company tax number. + financialYearStartDate: + $ref: '#/components/schemas/DateTime' + description: Start date of the financial year for the company. + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. + sourceUrls: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + description: |- + 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). + createdDate: + $ref: '#/components/schemas/DateTime' + description: Date the linked company was created in the accounting software. + supplementalData: + $ref: '#/components/schemas/SupplementalData' + examples: + - 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' + AccountingCreateAccountResponse: + title: 'Accounting: Create account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankAccountResponse: + title: 'Accounting: Create bank account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankTransactions: + title: 'Accounting: Create bank account transactions' + type: object + properties: + accountId: + type: string + description: Unique identifier for a bank account. + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - '7110701885' + - EILBDVJVNUAGVKRQ + - Checking 0202 + transactions: + type: array + items: + $ref: '#/components/schemas/AccountingCreateBankTransactions/definitions/CreateBankAccountTransaction' + definitions: + CreateBankAccountTransaction: + title: Bank account transaction + type: object + properties: + id: + type: string + description: 'Identifier for the bank account transaction, unique for the company in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + date: + $ref: '#/components/schemas/DateTime' + description: + nullable: false + type: string + description: Description of the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + AccountingCreateBankTransactionsResponse: + title: 'Accounting: Create/update bank transaction response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingCreateBankTransactions' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateDirectCostResponse: + title: 'Accounting: Create direct cost response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingDirectCost' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreatePaymentResponse: + title: 'Accounting: Create payment response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingPayment' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateSupplierResponse: + title: 'Accounting: Create supplier response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingSupplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateTransferResponse: + title: 'Accounting: Create transfer response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingTransfer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreditNote: + title: 'Accounting: Credit note' + description: |- + ## Overview + + Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely. + + In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable. + + It contains details of: + * The amount of credit remaining and its status. + * Payment allocations against the payments type, in this case an invoice. + * Which customers the credit notes have been issued to. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the credit note, unique to the company in the accounting software.' + creditNoteNumber: + type: string + nullable: true + description: Friendly reference for the credit note. + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the credit note has been issued to. + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: Total amount of credit that has been applied to the customer's accounts receivable + totalDiscount: + type: number + format: decimal + description: Any discounts applied to the credit note amount. + subTotal: + type: number + format: decimal + description: 'Value of the credit note, including discounts and excluding tax.' + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to credit note. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the credit note. + totalTaxAmount: + type: number + format: decimal + description: Any tax applied to the credit note amount. + discountPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of discounts applied to the credit note. + remainingCredit: + type: number + format: decimal + description: Unused balance of totalAmount originally raised. + status: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteStatus' + description: Current state of the credit note. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the credit note as recorded in the accounting system. + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the credit note was fully allocated. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + note: + type: string + nullable: true + description: 'Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - remainingCredit + - status + definitions: + creditNoteStatus: + title: Credit note status + description: Current state of the credit note. + type: string + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + creditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been issued.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been issued. + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The credit note is a direct income if `True`. + required: + - unitAmount + - quantity + examples: + - - id: 0316bd24-8a01-4a3a-a0e5-a73f14ebcbec + creditNoteNumber: '5239277' + customerRef: + id: b5511228-b9ef-4713-91b1-ad2cf60eadb1 + companyName: Tool Hire Company + totalAmount: 550 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 550 + status: Submitted + issueDate: '2018-03-28T21:28:58.249Z' + allocatedOnDate: null + note: More information available on request. + currency: USD + currencyRate: null + lineItems: + - description: Anvil10000Lb + unitAmount: 50 + quantity: 10 + discountAmount: 0 + subTotal: 500 + taxAmount: 50 + totalAmount: 550 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + name: null + discountPercentage: null + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: null + itemRef: + id: '1' + name: null + paymentAllocations: [] + modifiedDate: null + sourceModifiedDate: null + AccountingCreditNotes: + title: 'Accounting: Credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingCustomer: + title: 'Accounting: Customer' + description: | + ## 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). + + Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the customer, unique to the company in the accounting software.' + customerName: + type: string + nullable: true + description: 'Name of the customer as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the identified customer. + emailAddress: + type: string + nullable: true + description: Email address the customer can be contacted by. + defaultCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Default currency the transactional data of the customer is recorded in. + phone: + type: string + nullable: true + description: Phone number the customer can be contacted by. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + contacts: + type: array + nullable: true + description: An array of Contacts. + items: + $ref: '#/components/schemas/AccountingCustomer/definitions/contact' + registrationNumber: + type: string + nullable: true + description: 'Company number. In the UK, this is typically the Companies House company registration number.' + taxNumber: + type: string + nullable: true + description: Company tax number. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + description: Current state of the customer. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + accountingCustomerRef: + type: object + properties: + id: + minLength: 1 + type: string + description: '`id` from the Customers data type' + companyName: + type: string + nullable: true + description: '`customerName` from the Customer data type' + required: + - id + customerStatus: + description: Status of customer. + type: string + enum: + - Unknown + - Active + - Archived + contact: + type: object + properties: + name: + type: string + nullable: true + description: Name of a contact for a customer. + email: + type: string + nullable: true + description: Email of a contact for a customer. + phone: + type: array + nullable: true + description: An array of Phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + address: + $ref: '#/components/schemas/AccountingAddress' + description: An object of Address information. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + modifiedDate: + $ref: '#/components/schemas/DateTime' + required: + - status + AccountingCustomers: + title: 'Accounting: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCustomer' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectCost: + title: 'Accounting: Direct cost' + description: |- + > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software. + + ## Overview + + Direct costs are money that leave the business without impacting Accounts Payable, and refunds associated with such transactions. + + Direct costs include: + * Purchasing an item and paying it off at the point of the purchase + * Receiving cash from a refunded item if the refund is made by the supplier + + Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct cost, unique for the company.' + - $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + directCostPrototype: + type: object + properties: + reference: + type: string + nullable: true + description: User-friendly reference for the direct cost. + note: + type: string + nullable: true + description: A note attached to the direct cost. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct cost. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the direct cost as recorded in the accounting software.Date of the direct cost as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the direct cost. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostLineItem' + paymentAllocations: + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct costs, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct costs. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct costs, inclusive of tax.' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + directCostLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + Price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + Number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Collection of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountingDirectCost/definitions/tracking' + required: + - unitAmount + - quantity + tracking: + title: Invoiceable tracking + required: + - recordRefs + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + invoiceTo: + $ref: '#/components/schemas/AccountingRecordRef' + additionalProperties: false + invoiceTo: + type: object + title: Invoice to + description: Links to the customer the direct cost is associated. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + example: customers + AccountingDirectCosts: + title: 'Accounting: Direct costs' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectCost' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectIncome: + title: 'Accounting: Direct income' + description: | + > **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software. + + ## Overview + + Direct incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes made at the point of sale. + + Direct incomes include: + + - Selling an item directly to a contact, and receiving payment at the point of the sale. + - Refunding an item sold at the point of sale in cash to a contact. + + Direct incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct income, unique for the company.' + reference: + type: string + nullable: true + description: User-friendly reference for the direct income. + note: + type: string + nullable: true + description: An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct income. + issueDate: + $ref: '#/components/schemas/DateTime' + description: The date of the direct income as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the direct income. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectIncome/definitions/directIncomeLineItem' + paymentAllocations: + type: array + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct incomes, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct incomes. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct incomes, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + definitions: + directIncomeLineItem: + type: object + properties: + description: + type: string + nullable: true + description: A user-friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + The price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + The number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'The amount of the line, inclusive of discounts, but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: |- + The amount of tax for the line. + Note: If the platform does not provide this information, the quantity will be mapped as 0.00. + totalAmount: + type: number + format: decimal + nullable: true + description: 'The total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + description: An array of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + required: + - unitAmount + - quantity + AccountingDirectIncomes: + title: 'Accounting: Direct incomes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectIncome' + - $ref: '#/components/schemas/PagingInfo' + AccountingInvoice: + title: 'Accounting: Invoice' + description: |- + > **Invoices or bills?** + > + > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice. + > + > See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills. + + ## Overview + + An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer). + + In Codat, an invoice contains details of: + + - The timeline of the invoice—when it was raised, marked as paid, last edited, and so on. + - How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. + - Who the invoice has been raised to; the _customer_. + - The breakdown of what the invoice is for; the _line items_. + - Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_. + + > **Invoice PDF downloads** + > + > You can download a PDF version of an invoice for supported integrations. + > + > The filename will be invoice-{number}.pdf. + + > **Referencing an invoice in Sage 50 and ClearBooks** + > + > In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the invoice, unique to the company in the accounting software.' + invoiceNumber: + type: string + nullable: true + description: 'Friendly reference for the invoice. If available, this appears in the file name of invoice attachments.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the invoice has been issued to. + salesOrderRefs: + type: array + nullable: true + description: List of references to related Sales orders. + items: + title: Sales order reference + type: object + properties: + id: + type: string + description: Unique identifier to a record in `dataType`. + dataType: + type: string + description: The underlying data type associated to the reference `id`. + enum: + - salesOrders + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the invoice as recorded in the accounting system. + dueDate: + $ref: '#/components/schemas/DateTime' + description: Date the customer is due to be paid by. + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: 'Date the invoice was marked as paid in the accounting system. If this field is not available from the accounting software, it is calculated by Codat using associated payments.' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the invoice. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalDiscount: + type: number + format: decimal + nullable: true + description: Numerical value of discounts applied to the invoice. + subTotal: + type: number + format: decimal + nullable: true + description: Total amount of the invoice excluding any taxes. + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to invoice. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the invoice. + totalTaxAmount: + type: number + format: decimal + description: Amount of tax on the invoice. + totalAmount: + type: number + format: decimal + description: 'Amount of the invoice, inclusive of tax.' + amountDue: + type: number + format: decimal + description: Amount outstanding on the invoice. + discountPercentage: + type: number + format: decimal + nullable: true + description: 'Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`.' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + note: + type: string + nullable: true + description: 'Any additional information about the invoice. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - totalTaxAmount + - totalAmount + - amountDue + - status + definitions: + invoiceLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services provided. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services provided. + discountAmount: + type: number + format: decimal + nullable: true + description: Numerical value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate (from 0 to 100) of any discounts applied to the unit amount. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The invoice is a direct income if `True`. + required: + - unitAmount + - quantity + invoiceStatus: + type: string + enum: + - Unknown + - Draft + - Submitted + - PartiallyPaid + - Paid + - Void + description: |- + Current state of the invoice: + + - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email. + - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld). + - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`. + - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`. + - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. + AccountingInvoices: + title: 'Accounting: Invoices' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingInvoice' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournal: + title: 'Accounting: Journal' + description: | + > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type + + ## Overview + + In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. + + When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. + + Such journals can be divided into two categories: + + - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. + - General journals: journals used to record transactions that fall outside the scope of the special journals. + + Multiple journals or subjournals are used in the following Codat integrations: + + - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) + - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) + - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) + + > When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Journal ID. + - $ref: '#/components/schemas/AccountingJournal/definitions/journalPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalPrototype: + type: object + properties: + journalCode: + type: string + nullable: true + description: Native journal number or code. + name: + type: string + nullable: true + description: |- + Journal name. + The maximum length for a journal name is 256 characters. All characters above that number will be truncated. + type: + type: string + nullable: true + description: The type of the journal. + parentId: + type: string + nullable: true + description: |- + Parent journal ID. + If the journal is a parent journal, this value is not present. + hasChildren: + type: boolean + description: 'If the journal has child journals, this value is true. If it doesn’t, it is false.' + createdOn: + $ref: '#/components/schemas/DateTime' + description: Journal creation date. + status: + $ref: '#/components/schemas/AccountingJournal/definitions/journalStatus' + journalRef: + title: Journal reference + type: object + additionalProperties: false + description: Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). + properties: + id: + minLength: 1 + type: string + description: GUID of the underlying journal. + name: + type: string + maxLength: 256 + nullable: true + description: Name of journal + required: + - id + journalStatus: + type: string + description: Current journal status. + enum: + - Unknown + - Active + - Archived + AccountingJournalEntries: + title: 'Accounting: Journal entries' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournalEntry: + title: 'Accounting: Journal entry' + description: |- + > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type + + ## Overview + + A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. + + A journal entry line item is a single transaction line on the journal entry. For example: + + - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. + - When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue. + + In Codat a journal entry contains details of: + + - The date on which the entry was created and posted. + - Itemised lines, including amounts and currency. + - A reference to the associated accounts. + - A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. + + > **Pushing journal entries** + > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier of the journal entry for the company in the accounting software. + description: + type: string + nullable: true + description: Optional description of the journal entry. + postedOn: + $ref: '#/components/schemas/DateTime' + description: |- + Date on which the journal entry was posted to the accounting software, and had an impact on the general ledger. This may be different from the creation date. + + For example, a user creates a journal entry on Monday and saves it as draft, which has no impact on the general ledger. On Thursday, they return to the entry and post it. + + The **createdOn** date shows as Monday. + The **postedOn** date shows as Thursday. + Journal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date. + createdOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was created in the accounting software. + updatedOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was last updated in the accounting software. + journalRef: + $ref: '#/components/schemas/AccountingJournal/definitions/journalRef' + journalLines: + type: array + nullable: true + description: An array of journal lines. + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine' + recordRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalEntryRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the journal line item. + netAmount: + type: number + format: decimal + description: 'Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.' + transactionAmount: + type: number + format: decimal + description: The amount in the original transaction currency. + currency: + type: string + nullable: true + description: Currency for the journal line item. + transactionCurrency: + type: string + nullable: true + description: Currency of the original transaction. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + tracking: + description: 'List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)' + title: Tracking + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + nullable: true + definitions: + trackingRecordRef: + type: object + title: Record reference + description: Links to the customer or tracking category. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + - suppliers + - trackingCategories + example: trackingCategories + contactRef: + title: Contact reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for a customer or supplier. + dataType: + type: string + nullable: true + description: Allowed name of the 'dataType'. + enum: + - customers + - suppliers + required: + - id + required: + - netAmount + journalEntryRecordRef: + type: object + title: Record reference + description: Links a journal entry to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingJournals: + title: 'Accounting: Journals' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournal' + - $ref: '#/components/schemas/PagingInfo' + AccountingPayment: + title: 'Accounting: Payment' + description: "\uFEFF> **Payments or bill payments?**\n>\n> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills.\n\n## Overview\n\nPayments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).\n\nA payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:\n\n- A payment made against an invoice, like a credit card, cheque, or cash payment.\n- An allocation of a customer's credit note, either to an invoice or maybe a refund.\n- A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.\n\nDepending on the payments allowed by the underlying accounting software, some payment types may be combined. Please see the example for more details.\n\nIn Codat, a payment contains details of:\n\n- When the payment was recorded in the accounting system.\n- How much it is for and in what currency that amount is in.\n- Who the payment was _paid by_ – the _customer_.\n- The payment method used.\n- The breakdown of the types of payments – the _line items_.\n\nPayments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n\n## Payment types\n\n## Payment of an invoice\n\nA payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:\n\n- An _amount_ that indicates the amount of the invoice that was paid. This is always positive.\n- A **links** array containing one element with the following properties:\n - A **type** that indicates the type of **link**, in this case an `Invoice`.\n - An **id** that contains the ID of the invoice that was paid.\n - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n## Payment of multiple invoices\n\nA single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:\n\n- The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).\n- The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.\n\nEach **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.\n\n## Payments and refunds on account\n\nA payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:\n\n- A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.\n- A **links** array containing one element with the following properties:\n- A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.\n- The **id** containing the ID of the customer.\n- The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.\n\nIt is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.\n\n## Using a credit note to pay an invoice\n\nThe payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:\n\n- An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.\n- A **links** array containing two elements:\n - The first **link** has:\n - A **type** that indicates the type of **link**, in this case an `Invoice`.\n - An **id** that contains the ID of the invoice that was paid.\n - The second **link** has:\n - A **type** that indicates the type of **link**, in this case a `CreditNote`.\n - An **id** that contains the ID of the credit note used by this payment.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n## Refunding a credit note\n\nA payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:\n\n- An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.\n- A **links** array that contains one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `CreditNote`.\n - An **id** that contains the ID of the credit note that was refunded.\n\nThe **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.\n\n## Refunding a payment\n\nIf a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:\n\n- One for the incoming over payment.\n- Another for the outgoing refund.\n\nThe payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:\n\n- An **amount** that indicates the amount that was refunded. This is always negative.\n- A **links** array that contains one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `Payment`.\n - An **id** that contains the ID of the payment that was refunded.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.\n\nThe payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.\n\nFor example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:\n\n- One for £1,000 linked to the invoice that was paid.\n- Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.\n\nThe **line** linked to the payment has the following properties:\n\n- An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.\n- A **links** array containing one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `Refund`.\n - An **id** that contains the ID of the payment that refunded this line.\n\n> **Support for linked payments**\n>\n> Not all accounting software support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.\n\n## Foreign currencies\n\nThere are two types of currency rate that are included in the payments data type:\n\nPayment currency rate:\n\n- Base currency of the accounts receivable account.\n- Foreign currency of the payment.\n\nPayment line link currency rate:\n\n- Base currency of the item the link represents.\n- Foreign currency of the payment.\n\nThese two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:\n\n- The base currency for the accounts receivable account.\n- The currency of the item.\n\n ```json title=\"Currency rate example\"\n {\n \"id\": \"123\",\n \"note\": \"\",\n \"totalAmount\": 99.99,\n \"currency\": \"GBP\",\n \"lines\": [\n {\n \"amount\": 99.99,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"178\",\n \"amount\": -50,\n \"currencyRate\": 1.9998\n }\n ]\n }\n ]\n }\n ```\n\n\n\n## Example data\n\n> **Object properties**\n>\n> For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).\n\n## Simple examples\n\n ```json title=\"Payment for invoice\"\n {\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Allocation of credit note\"\n {\n \"totalAmount\": 0,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Payment of invoice and payment on account\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"y\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Refund of credit note\"\n {\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Refund on accounts receivable account\"\n {\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Linked refund on accounts receivable account\"\n {\n \"id\" : \"payment-001\",\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Refund\",\n \"id\" : \"refund-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n {\n \"id\" : \"refund-001\",\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"Payment\",\n \"id\" : \"payment-001\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Using a credit note and cash to pay an invoice\"\n {\n \"totalAmount\": 250,\n \"lines\": [\n {\n \"amount\": 0,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"x\",\n \"amount\": -750\n }, \n {\n \"type\": \"CreditNote\",\n \"id\": \"y\",\n \"amount\": 750\n }\n ]\n },\n {\n \"amount\": 250,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"x\",\n \"amount\": -250\n }\n ]\n }\n ]\n }\n ```\n\n\n\n## Complex examples\n\n ```json title=\"Use two credit notes and 1000 in to \"bank\" (cash, cheque etc.) to pay invoice\"\n {\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Pay an invoice with two credit notes and cash, with 1000 left 'on account'\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"customer-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes pay two invoices with no allocation amount specified\"\n {\n \"totalAmount\": 0,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"w\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"w\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"u\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Refund\",\n \"id\" : \"refund-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n {\n \"id\" : \"refund-001\",\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"Payment\",\n \"id\" : \"payment-001\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\nIn this example, a payment on account is used to pay the same invoice in January and again in February.\n\n ```json title=\"January\"\n {\n \"id\": \"001\",\n \"totalAmount\": 5000,\n \"date\" : \"1901-01-01\",\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 4000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"PaymentOnAccount-y\",\n \"amount\" : -4000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"February\"\n {\n \"id\": \"001\",\n \"totalAmount\": 5000,\n \"date\" : \"1901-02-01\",\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-y\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 3000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"PaymentOnAccount-y\",\n \"amount\" : -3000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes and some cash pay two invoices with no allocations specified\"\n {\n \"totalAmount\": 500,\n \"lines\": [\n {\n \"amount\": 500,\n \"links\": [{\n \"type\": \"Invoice\",\n \"id\": \"a\",\n \"amount\": -1000\n }, {\n \"type\": \"Invoice\",\n \"id\": \"b\",\n \"amount\": -1000\n }, {\n \"type\": \"CreditNote\",\n \"id\": \"y\",\n \"amount\": 750\n },{\n \"type\": \"CreditNote\",\n \"id\": \"z\",\n \"amount\": 750\n }\n ]\n }\n ]\n }\n ```" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the payment, unique to the company in the accounting software.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Customer the payment is recorded against in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is recorded against in the accounting software. + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + description: The Payment Method to which the payment is linked in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: ISO currency code recorded for the payment in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + $ref: '#/components/schemas/DateTime' + description: Date the payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Any additional information associated with the payment. + lines: + type: array + nullable: true + description: An array of payment lines. + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLine' + reference: + type: string + nullable: true + description: Friendly reference for the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + paymentLine: + title: Payment Line + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + required: + - amount + paymentLineLink: + title: Payment Line Link + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLinkType' + id: + type: string + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: |- + Amount by which the balance of the linked entity is altered, in the currency of the linked entity. + A negative link amount _reduces_ the outstanding amount on the accounts receivable account. + A positive link amount _increases_ the outstanding amount on the accounts receivable account. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + paymentLinkType: + title: Payment Link Type + type: string + enum: + - Unknown + - Unlinked + - Invoice + - CreditNote + - Other + - Refund + - Payment + - PaymentOnAccount + - ManualJournal + - Discount + description: |- + Types of payment line links, either: + `Unknown` + `Unlinked` - Not used + `Invoice` - ID refers to the invoice + `CreditNote` - ID refers to the credit note + `Refund` - ID refers to the sibling payment + `Payment` - ID refers to the sibling payment + `PaymentOnAccount` - ID refers to the customer + `Other` - ID refers to the customer + `Manual Journal` + `Discount` - ID refers to the payment + AccountingPaymentAllocation: + title: 'Accounting: Payment allocation' + type: object + properties: + payment: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment' + allocation: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + totalAmount: + type: number + format: decimal + description: The total amount that has been allocated. + required: + - payment + - allocation + definitions: + paymentAllocationPayment: + type: object + properties: + id: + type: string + description: Identifier of the allocated payment. + note: + type: string + nullable: true + description: Notes attached to the allocated payment. + reference: + type: string + nullable: true + description: Reference to the allocated payment. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: The account that the allocated payment is made from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency the payment has been made in. + currencyRate: + title: Currency rate + type: number + format: decimal + nullable: true + description: |- + 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. | + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was paid. + totalAmount: + type: number + format: decimal + description: Total amount that was paid. + AccountingPaymentMethod: + title: 'Accounting: Payment method' + description: |- + ## Overview + + A Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/lending-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier for the payment method. + name: + type: string + nullable: true + description: Name of the payment method. + type: + $ref: '#/components/schemas/AccountingPaymentMethod/definitions/paymentMethodType' + status: + $ref: '#/components/schemas/CommercePaymentMethod/allOf/1/properties/status' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentMethodType: + description: Method of payment. + type: string + enum: + - Unknown + - Cash + - Check + - CreditCard + - DebitCard + - BankTransfer + - Other + AccountingPayments: + title: 'Accounting: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingProfitAndLossReport: + title: 'Accounting: Profit and loss report' + description: |- + > **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles). + + ## Overview + + The purpose of a profit and loss report is to present the financial performance of a company over a specified time period. + + A profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made. + + > **Profit and loss or balance sheet?** + > Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date. + + + **Structure of this report** + This report will reflect the structure and line descriptions that the business has set in their own accounting software. + + **History** + By default, Codat pulls (up to) 24 months of profit and loss history for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `profitAndLoss` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/post-profile-syncSettings). + + **Want to pull this in a standardised structure?** + Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. + type: object + properties: + reports: + type: array + description: An array of profit and loss reports. + items: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/profitAndLossReport' + reportBasis: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/reportBasis' + currency: + type: string + description: Base currency of the company in which the profit and loss report is presented. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Earliest available monthly report data. + required: + - reports + - reportBasis + definitions: + reportBasis: + enum: + - Unknown + - Accrual + - Cash + type: string + description: The basis of a report. + profitAndLossReport: + type: object + additionalProperties: false + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Date from which the report data begins. + toDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the report data ends. + income: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for income in the given date range. + costOfSales: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for cost of sales in the given date range. + grossProfit: + type: number + format: decimal + description: Gross profit of the company in the given date range. + expenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for expenses in the given date range. + netOperatingProfit: + type: number + format: decimal + description: Net operating profit of the company in the given date range. + otherExpenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other expenses in the given date range. + otherIncome: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other income in the given date range. + netOtherIncome: + type: number + format: decimal + description: Net other income of the company in the given date range. + netProfit: + type: number + format: decimal + description: Net profit of the company in the given date range. + required: + - grossProfit + - netOperatingProfit + - netOtherIncome + - netProfit + AccountingRecordRef: + type: object + x-internal: true + title: Record reference + description: |- + Links the current record to the underlying record or data type that created it. + + For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Allowed name of the 'dataType'. + examples: + - journalEntry + - invoice + - accountTransaction + - transfer + AccountingSupplier: + title: 'Accounting: Supplier' + description: |- + ## Overview + + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: + type: string + nullable: true + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the supplier. + emailAddress: + type: string + nullable: true + description: Email address that the supplier may be contacted on. + phone: + type: string + nullable: true + description: Phone number that the supplier may be contacted on. + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + registrationNumber: + type: string + nullable: true + description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' + taxNumber: + type: string + nullable: true + description: Supplier's company tax number. + status: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierStatus' + defaultCurrency: + type: string + nullable: true + description: Default currency the supplier's transactional data is recorded in. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. + type: object + properties: + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. + type: string + enum: + - Unknown + - Active + - Archived + examples: + - 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' + AccountingSuppliers: + title: Suppliers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingSupplier' + - $ref: '#/components/schemas/PagingInfo' + AccountingTrackingCategory: + x-internal: true + title: 'Accounting: Tracking category' + description: |- + Details of a category used for tracking transactions. + + > Language tip + > + > Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting software. In Codat, we refer to these as tracking categories. + + ## Overview + + Tracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers. + + From their accounting system, customers can: + + - Create and maintain tracking categories and tracking category types. + - View all tracking categories that are available for use. + - View the relationships between the categories. + - Assign invoices, bills, credit notes, or bill credit notes to one or more categories. + - View the categories that a transaction belongs to. + - View all transactions in a tracking category. + + ### Tracking categories per platform + + Review the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
+ + > **Example use case** + > + > Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**. + + If a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'The identifier for the item, unique per tracking category.' + nullable: true + name: + type: string + description: The name of the tracking category. + nullable: true + status: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/status' + parentId: + type: string + description: The identifier for this item's immediate parent. + nullable: true + hasChildren: + type: boolean + description: Boolean value indicating whether this category has SubCategories. + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + trackingCategoryRef: + required: + - id + type: object + description: References a category against which the item is tracked. + deprecated: true + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the tracking category. + name: + type: string + nullable: true + description: Name of tracking category. + status: + title: Tracking category status + type: string + description: Current state of the tracking category. + enum: + - Unknown + - Active + - Archived + examples: + - id: string + name: string + status: Unknown + parentId: string + hasChildren: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + AccountingTransfer: + title: 'Accounting: Transfer' + description: 'A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).' + allOf: + - properties: + id: + type: string + description: Unique identifier for the transfer. + description: + type: string + nullable: true + description: Description of the transfer. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: 'The customer or supplier for the transfer, if available.' + date: + $ref: '#/components/schemas/DateTime' + description: The day on which the transfer was made. + from: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving from. + to: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving to. + status: + description: The status of the transfer in the account + type: string + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + nullable: true + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories this transfer is being tracked against. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + depositedRecordRefs: + type: array + nullable: true + description: List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. + items: + $ref: '#/components/schemas/AccountingRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + transferAccount: + title: Transfer account + description: Account details of the account sending or receiving the transfer. + type: object + properties: + accountRef: + $ref: '#/components/schemas/AccountingRecordRef' + description: The account that the transfer is moving from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + amount: + type: number + format: decimal + description: The amount transferred between accounts. + type: object + AccountingTransfers: + title: 'Accounting: Transfers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingTransfer' + - $ref: '#/components/schemas/PagingInfo' + AccountsPayableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + description: Defines if the invoice or credit note is billed/rebilled to a project or customer. + enum: + - Unknown + - NotApplicable + - Customer + - Project + AccountsReceivableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + recordRef: + $ref: '#/components/schemas/AccountingRecordRef' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + enum: + - Unknown + - NotApplicable + - Project + description: Defines if the bill or bill credit note is billed/rebilled to a project. + AgedCurrencyOutstanding: + type: object + title: 'Accounting: Aged currency outstanding' + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + agedOutstandingAmounts: + type: array + description: Array of outstanding amounts by period. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmount' + definitions: + agedOutstandingAmount: + type: object + title: Aged outstanding amount + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date of period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date of period. + amount: + type: number + format: decimal + description: The amount outstanding. + details: + type: array + description: Array of details. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmountDetail' + agedOutstandingAmountDetail: + type: object + title: Amounts outstanding by data type + properties: + name: + type: string + description: Name of data type with outstanding amount for given period. + amount: + type: number + format: decimal + description: The amount outstanding. + Attachments: + x-internal: true + type: object + properties: + attachments: + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + title: Attachments + BankFeedBankAccountMapping: + title: Bank feed account mapping + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The date from which bank transactions can be provided to the platform. + required: + - sourceAccountId + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + BankFeedBankAccountMappingResponse: + title: Bank feed account mapping response + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account. + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account. + status: + type: string + nullable: true + description: Status of the POST request. + error: + type: string + nullable: true + description: Error returned during the post request + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + status: Failed + error: A feed connection already exists to this account + BankFeedMapping: + title: Bank feed mapping + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account. + sourceAccountName: + type: string + description: Name for the source account. + sourceAccountNumber: + type: string + description: Account number for the source account. + sourceBalance: + type: number + format: decimal + description: Balance for the source account. + sourceCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account in the accounting software. + targetAccountName: + type: string + description: Name for the target account in the accounting software. + status: + type: string + description: The status. + targetAccountOptions: + type: array + nullable: true + description: An array of potential target accounts. + items: + $ref: '#/components/schemas/BankFeedMapping/definitions/targetAccountOption' + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The date from which bank transactions can be provided to the platform. + description: 'A bank feed connection between a source account and a target account, including potential target accounts.' + definitions: + targetAccountOption: + title: Target Account Option + type: object + properties: + id: + type: string + description: Id of the target account. + name: + type: string + nullable: true + description: Name of the target account. + balance: + type: number + format: decimal + nullable: true + description: The balance of the account. + sortCode: + type: string + nullable: true + description: The sort code of the account. + accountNumber: + type: string + nullable: true + description: The account number of the account. + bankFeedMappings: + title: Bank feed mappings + type: array + items: + $ref: '#/components/schemas/BankFeedMapping' + additionalProperties: false + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + sourceCurrency: USD + status: Success + feedStartDate: '2023-01-09T14:14:14.1057478Z' + sourceAccountName: ACME Bank + sourceAccountNumber: 1234-5678 + sourceBalance: 500 + targetAccountName: ACME Bank + - sourceAccountId: c53fd75a-dddb-4493-839a-5090b008f625 + status: pending + targetAccountOptions: + - name: account-081 + id: 044096a7-1478-4554-8820-f478caad1b00 + balance: 100.99 + sortCode: '602336' + accountNumber: '23203' + sourceAccountName: bank name here + sourceAccountNumber: '5670' + sourceBalance: 1550 + sourceCurrency: GBP + BankingAccount: + title: 'Banking: Bank account' + description: |- + This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The ID of the account from the provider. + name: + minLength: 1 + type: string + description: The name of the account according to the provider. + informalName: + type: string + nullable: true + description: 'The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.' + holder: + type: string + nullable: true + description: The name of the person or company who holds the account. + type: + $ref: '#/components/schemas/AccountingBankAccountType' + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + description: An object containing bank balance data. + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + currency: + minLength: 1 + type: string + description: The currency code for the account. + institution: + $ref: '#/components/schemas/BankingAccount/definitions/accountInstitution' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + - type + - balance + - identifiers + - currency + - institution + definitions: + accountIdentifiers: + title: Account Identifiers + description: An object containing bank account identification information. + type: object + x-internal: true + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifierType' + subtype: + type: string + nullable: true + description: Detailed account category + number: + type: string + nullable: true + description: 'The account number for the account. When combined with the`bankCode`, this is usually enough to uniquely identify an account within a jurisdiction.' + bankCode: + type: string + nullable: true + description: |- + The local (usually national) routing number for the account. + + This is known by different names in different countries: + * BSB code (Australia) + * routing number (Canada, USA) + * sort code (UK) + iban: + type: string + nullable: true + description: 'The international bank account number (IBAN) for the account, if known.' + bic: + type: string + nullable: true + description: 'The ISO 9362 code (commonly called SWIFT code, SWIFT-BIC or BIC) for the account.' + maskedAccountNumber: + type: string + nullable: true + description: A portion of the actual account `number` to help account identification where number is tokenised (Plaid only) + required: + - type + accountIdentifierType: + type: string + x-internal: true + description: Type of account + enum: + - Account + - Card + - Credit + - Depository + - Investment + - Loan + - Other + accountInstitution: + title: Account Institution + description: The bank or other financial institution providing the account. + x-internal: true + type: object + additionalProperties: false + properties: + id: + type: string + description: 'The institution''s ID, according to the provider.' + name: + type: string + description: 'The institution''s name, according to the underlying provider.' + examples: + - results: + - id: 1703194f-7805-4da8-bac0-2ba5da4a4216 + name: Business Current Account + informalName: Codat + holder: Codat Ltd + type: Debit + balance: + available: -459987.97 + current: -459964.9 + limit: 5000 + identifiers: + type: Depository + subtype: checking + number: '46762629' + bankCode: 009911 + iban: GB29 LOYD 4773 2346 7626 29 + bic: LOYDGB21006 + maskedAccountNumber: LOYDGB21006 + currency: GBP + institution: + id: lloyds-bank + name: Lloyds Bank + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-08-14T05:04:12' + BankingAccountBalance: + title: 'Banking: Account balance' + description: |- + The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + + > **How often should I pull Account Balances?** + > + > Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/lending-api#/schemas/Account) data type. + > + > Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer. + type: object + allOf: + - type: object + properties: + accountId: + minLength: 1 + type: string + description: The unique identifier of the account. + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + date: + $ref: '#/components/schemas/DateTime' + description: Date of the balance. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - accountId + - balance + - date + definitions: + accountBalanceAmounts: + title: Account Balance Amounts + x-internal: true + type: object + properties: + available: + type: number + format: decimal + nullable: true + description: 'The balance available in the account, including any pending transactions. This doesn''t include additional funds available from any overdrafts.' + current: + type: number + format: decimal + description: The balance of the account only including cleared transactions. + limit: + type: number + format: decimal + nullable: true + description: 'The minimum allowed balance for the account. For example, a $100.00 overdraft would show as a limit of `-100.00`.' + additionalProperties: false + description: 'Depending on the data provided by the underlying bank, not all balances are always available.' + examples: + - accountBalances: + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-18T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-19T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714195.66 + current: 714204.39 + limit: 5000 + date: '2021-03-22T00:00:00' + - accountId: 2f593774-1075-4805-a552-84eecc7eb264 + balance: + available: -644945.42 + current: -644925.84 + limit: 0 + date: '2022-03-09T00:00:00' + BankingAccountBalances: + title: 'Banking: Account balances' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccountBalance' + - $ref: '#/components/schemas/PagingInfo' + BankingAccounts: + title: 'Banking: Bank accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/PagingInfo' + BankingTransaction: + title: 'Banking: Transaction' + description: |- + The Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction. + accountId: + minLength: 1 + type: string + description: The unique identifier of the bank account. + description: + type: string + nullable: true + description: The description of the bank transaction. + amount: + type: number + format: decimal + description: The amount of the bank transaction. + currency: + minLength: 1 + type: string + description: The currency of the bank transaction. + postedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was cleared. + authorizedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was authorized. + code: + $ref: '#/components/schemas/BankingTransaction/definitions/transactionCode' + merchantName: + type: string + nullable: true + description: The name of the merchant. + transactionCategoryRef: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryRef' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - accountId + - currency + definitions: + transactionCode: + type: string + x-internal: true + description: Code to identify the underlying transaction. + enum: + - Unknown + - Fee + - Payment + - Cash + - Transfer + - Interest + - Cashback + - Cheque + - DirectDebit + - Purchase + - StandingOrder + - Adjustment + - Credit + - Other + - NotSupported + examples: + - id: 0130b5bb-1419-40f6-8a27-7362d0381229 + accountId: 1703194f-7805-4da8-bac0-2ba5da4a4216 + description: Payments for direct income ce149943-c157-43fc-aac7-42a716b655b6 + amount: 5062.39 + currency: GBP + postedDate: '2021-07-06T00:00:00' + authorizedDate: '2021-07-06T00:00:00' + merchantName: New Look + transactionCategoryRef: + id: health-and-fitness-sports + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-06-28T10:48:12' + BankingTransactionCategories: + title: 'Banking: Transaction categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransactionCategory' + - $ref: '#/components/schemas/PagingInfo' + BankingTransactionCategory: + title: 'Banking: Transaction category' + description: |- + The Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + description: Status of the bank transaction category. + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction category. + name: + minLength: 1 + type: string + description: The name of the bank transaction category. + parentId: + type: string + nullable: true + description: The unique identifier of the parent bank transaction category. + hasChildren: + type: boolean + description: A Boolean indicating whether there are other bank transaction categories beneath this one in the hierarchy. + status: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + definitions: + transactionCategoryRef: + type: object + x-internal: true + description: An object of bank transaction category reference data. + properties: + id: + minLength: 1 + type: string + description: The unique category reference id for the bank transaction. + name: + type: string + nullable: true + description: The category name reference for the bank transaction. + required: + - id + transactionCategoryStatus: + type: string + description: The status of the transaction category. + x-internal: true + enum: + - Unknown + - Active + - Archived + examples: + - id: auto-and-transport + name: Auto & Transport + hasChildren: true + status: Active + modifiedDate: '2022-05-23T16:32:50' + sourceModifiedDate: '2021-04-24T07:59:10' + BankingTransactions: + title: 'Banking: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransaction' + - $ref: '#/components/schemas/PagingInfo' + BankStatementUploadConfiguration: + title: Banking data upload settings + description: Configuration settings for uploading banking data to Codat + additionalProperties: false + type: object + properties: + source: + type: string + enum: + - codat + description: The source of the banking data that determines its format + accountId: + type: string + description: The ID of the account in the third-party platform + providerId: + type: string + description: TrueLayer provider ID (only required if source is TrueLayer) + CategorizedBankStatementAccounts: + title: Categorized bank statement accounts + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow accounts endpoint provides a list of accounts that categorized transactions have been taken from. + allOf: + - type: object + properties: + results: + type: array + items: + title: Account + type: object + properties: + id: + description: The ID of the account from the provider. + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=2&pageSize=10 + CategorizedBankStatementTransactions: + title: Categorized bank statement transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + isRecurring: true + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + isRecurring: false + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + ClientRateLimitWebhook: + title: Client rate limit webhook + type: object + properties: + id: + type: string + format: uuid + example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - client.rateLimit.reset + - client.rateLimit.reached + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' + definitions: + clientRateLimitWebhookPayload: + title: Client rate limit webhook payload + type: object + properties: + dailyQuota: + type: integer + description: The number of available requests per day. + quotaRemaining: + type: integer + description: Total number of requests remaining for your client. + expiryDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC when your daily quota is reset. + CommerceAddress: + title: 'Commerce: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/CommerceAddress/definitions/commerceAddressType' + line1: + description: The first line of the address + type: string + line2: + description: The second line of the address + type: string + city: + description: 'The third line of the address, or city' + type: string + region: + description: 'The fourth line of the address, or region' + type: string + country: + description: The country for the address + type: string + postalCode: + description: The postal (or zip) code for the address + type: string + definitions: + commerceAddressType: + description: The type of the address + type: string + enum: + - Billing + - Delivery + - Order + - Inventory + - Unknown + CommerceCompanyInfo: + title: 'Commerce: Company profile' + description: | + In the Codat system, company profile includes standard commercial details about + a linked company, such as their address, phone number, and company registration. + type: object + allOf: + - type: object + properties: + companyName: + type: string + description: The name of the company + example: Codat + commercePlatformRef: + type: string + description: Identifier or reference for the company in the commerce software + companyLegalName: + type: string + description: The full legal name of the company + example: Codat Limited + addresses: + type: array + description: Addresses associated with the company + items: + $ref: '#/components/schemas/CommerceAddress' + phoneNumbers: + type: array + description: Phone numbers associated with the company + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + description: Weblinks associated with the company + type: array + items: + $ref: '#/components/schemas/WebLink' + registrationNumber: + description: The registration number of the company + type: string + examples: + - 10480375 + baseCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + accountBalances: + description: The available and current cash balances for the company's accounts + type: array + items: + $ref: '#/components/schemas/CommerceCompanyInfo/definitions/accountBalance' + sourceUrls: + description: 'URL addresses for the originating system. For example, potential use cases include ''deeplinking'' to the originating system' + type: object + additionalProperties: + type: string + example: + url1: 'https://connect.sandbox.com/v2/customers' + url2: 'https://connect.sandbox.com/v2/disputes' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountBalance: + title: Account Balance + type: object + x-internal: true + properties: + available: + description: The account's current balance + type: number + format: decimal + pending: + description: Funds that are not yet available in the balance + type: number + format: decimal + reserved: + description: Funds reserved as holdings + format: decimal + currency: + description: The currency of the account + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + CommerceCustomer: + title: 'Commerce: Customer' + description: 'When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + customerName: + type: string + description: Name of the customer + example: Fred Smith + emailAddress: + type: string + description: Email address of the customer + example: fred.smith@myCompany.com + phone: + $ref: '#/components/schemas/PhoneNumber/properties/number' + defaultCurrency: + allOf: + - description: | + Default currency of any transactional data for the customer, + for example, orders or payments + - $ref: '#/components/schemas/SourceAccount/properties/currency' + addresses: + type: array + description: Addresses of the customer + items: + $ref: '#/components/schemas/CommerceAddress' + note: + type: string + description: Any additional information about the customer + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + commerceCustomerRef: + type: object + description: Reference to the customer that placed the order. + properties: + id: + description: The unique identitifer of the customer being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the customer being referenced. + type: string + required: + - id + examples: + - customers: + - id: '15' + customerName: Daffy Duck + emailAddress: d.duck@warnerbros.com + defaultCurrency: GBP + phone: (877) 492-8687 + addresses: + - type: billing + line1: 301 Duck Pond + line2: 28 Green Street + city: London + region: England + country: United Kingdom + postalCode: WX1X 0BE + - type: delivery + line1: Bread Street + line2: Bird Avenue + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-09-15T23:52:28' + - id: '18' + customerName: Tasmanian Devil + emailAddress: t.devil@warnerbros.com + defaultCurrency: GBP + phone: +1-202-555-0181 + addresses: + - type: billing + line1: 101 Fire Rooms + line2: Engine Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + note: Handle with care + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-04-16T02:41:52' + - id: a99f5e0c-a4db-452f-8d2c-8fd15482b384 + customerName: Bugs Bunny + emailAddress: b.bunny@warnerbros.com + defaultCurrency: GBP + phone: '' + addresses: + - type: billing + line1: 301 Carrot Street + line2: Orange Town + city: Yorkshire + region: England + country: United Kingdom + postalCode: WF1X 0BE + - type: delivery + line1: 424 Field Street + line2: The Meadow + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceCustomers: + title: 'Commerce: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceCustomer' + - $ref: '#/components/schemas/PagingInfo' + CommerceDispute: + title: 'Commerce: Dispute' + description: |- + A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example: + - They didn't receive an order. + - The product they received was different to the commerce store's description. + - They've been the victim of online fraud. + + You can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + required: + - currency + properties: + disputedTransactions: + description: Link to the source event(s) which triggered this transaction. + type: array + items: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + totalAmount: + description: Total transaction amount that is under dispute. + format: decimal + examples: + - 194.12 + - -283.56 + - 0 + currency: + description: Currency of the disputed transaction. + $ref: '#/components/schemas/SourceAccount/properties/currency' + status: + $ref: '#/components/schemas/CommerceDispute/definitions/disputeStatus' + reason: + description: Reason for the dispute + type: string + examples: + - Unhappy with product + dueDate: + description: Date when the next action in the dispute resolution is due + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + disputeStatus: + description: Current status of the dispute + x-internal: true + type: string + enum: + - Won + - Lost + - Accepted + - Processing + - ChargeRefunded + - EvidenceRequired + - InquiryEvidenceRequired + - InquiryProcessing + - InquiryClosed + - WaitingThirdParty + - Unknown + example: EvidenceRequired + examples: + - id: 03e608e3-bd1c-454f-8c2b-fb0133e43b95 + disputedTransactions: + - id: e63ad857-7e12-4e64-9185-cdfd7c45d09d + type: Order + totalAmount: -47.66 + currency: GBP + status: InquiryEvidenceRequired + reason: Unhappy with product + dueDate: '2021-03-29T14:39:55' + createdDate: '2021-03-22T14:39:55' + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-22T14:39:55' + CommerceDisputes: + title: 'Commerce: Disputes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceDispute' + - $ref: '#/components/schemas/PagingInfo' + CommerceLocation: + title: 'Commerce: Location' + type: object + description: |- + The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. + + A Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + description: Name of this location + type: string + address: + description: Address associated with the location + $ref: '#/components/schemas/CommerceAddress' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + locationRef: + type: object + description: Reference to the geographic location where the order was placed. + properties: + id: + description: The unique identitifer of the location being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the location being referenced. + type: string + required: + - id + examples: + - id: '15' + name: London Warehouse + address: + type: Inventory + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalCode: WC1X 8WB + modifiedDate: '2020-08-12T14:37:37' + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceLocations: + title: 'Commerce: Locations' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceLocation' + - $ref: '#/components/schemas/PagingInfo' + CommerceOrder: + title: 'Commerce: Order' + description: | + Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). + allOf: + - type: object + x-stoplight: + id: 516bf0ecc4907 + required: + - id + properties: + id: + type: string + description: 'A unique, persistent identifier for this record' + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + x-codat-validation: + - validator: UniqueWithinConnection + - properties: + orderNumber: + type: string + description: Friendly reference for the order in the commerce or point of sale platform. + country: + description: |- + The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part. + + Depending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model. + + For POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint. + type: string + format: ISO3166 Alpha-3 + examples: + - GBR + - USA + - ABW + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: Currency in which the order was placed. + closedDate: + $ref: '#/components/schemas/DateTime' + description: 'Date on which order was closed after the product was shipped, paid for, and any refund period had elapsed.' + totalAmount: + description: 'Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.' + type: number + format: decimal + totalRefund: + description: 'Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.' + type: number + format: decimal + totalTaxAmount: + description: Total amount of tax applied to the order. + type: number + format: decimal + totalDiscount: + description: 'Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).' + type: number + format: decimal + totalGratuity: + description: Extra amount added to the order. + type: number + format: decimal + orderLineItems: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderLineItem' + payments: + type: array + items: + $ref: '#/components/schemas/CommercePayment/definitions/paymentRef' + serviceCharges: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceCharge' + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + customerRef: + $ref: '#/components/schemas/CommerceCustomer/definitions/commerceCustomerRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - title: Created date + type: object + x-internal: true + properties: + createdDate: + $ref: '#/components/schemas/DateTime' + description: The date the entity was created. + - title: Modified dates + x-internal: true + allOf: + - title: ModifiedDate + x-internal: true + type: object + properties: + modifiedDate: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: |- + The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. + + Use it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today. + + This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)). + + In Codat's data model, dates and times are represented using the ISO 8601 standard. + - title: Source Modified Date + x-internal: true + type: object + nullable: true + properties: + sourceModifiedDate: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: |- + The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. + + It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: + - Pulling attachments + - The accounting software does not provide modification dates for a data type + - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred + - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records + + In Codat's data model, dates and times are represented using the ISO 8601 standard. + definitions: + orderLineItem: + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + quantity: + type: number + format: decimal + description: | + Number of units of the product sold. + For refunds, quantity is negative. + taxPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of any sales tax applied to the unit price. + examples: + - 0 + - 12.5 + - '45.00' + totalAmount: + type: number + format: decimal + description: 'Total amount of the line item, including discounts and tax.' + totalTaxAmount: + type: number + format: decimal + description: 'Total amount of tax applied to the line item, factoring in any discounts.' + unitPrice: + type: number + format: decimal + description: 'Price per unit of goods or services, excluding discounts and tax.' + taxes: + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + description: Taxes breakdown as applied to order lines. + productRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productRef' + productVariantRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantRef' + discountAllocations: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderDiscountAllocation' + serviceCharge: + type: object + properties: + description: + description: Service charges for this order. + type: string + example: A service charge + totalAmount: + description: 'Total amount of the service charge, including tax.' + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxPercentage: + description: Percentage rate (from 0 to 100) of any tax applied to the service charge. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxAmount: + description: Amount of the service charge that is tax. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxes: + description: Taxes breakdown as applied to service charges. + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + quantity: + description: The number of times the charge is charged. + type: integer + examples: + - 1 + - 12 + - 45 + type: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceChargeType' + serviceChargeType: + description: The type of the service charge. + type: string + enum: + - Generic + - Shipping + - Overpayment + - Unknown + example: Overpayment + orderDiscountAllocation: + type: object + properties: + name: + type: string + description: Name of the discount in the commerce or point of sale platform. + example: Promotional Discount + totalAmount: + type: number + format: decimal + description: 'Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).' + example: 15.25 + examples: + - id: 01e63721-1205-478e-8503-9d8bf8a93f44 + orderNumber: '99123956' + country: CAN + currency: CAD + createdDate: '2021-03-28T03:00:14' + totalAmount: 12 + totalRefund: 0 + totalTaxAmount: 2 + totalDiscount: 0 + totalGratuity: 1 + orderLineItems: + - id: 116113a6-54d3-4624-ba73-26a77a5ffd51 + quantity: 1 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 10 + taxes: + - taxComponentRef: + id: '72' + name: Sales Tax + taxAmount: '' + - taxComponentRef: + id: '72' + name: City Tax + taxAmount: '' + productRef: + id: ac186646-41f2-4280-afea-1012c59459ab + name: Intelligent Concrete Salad + productVariantRef: + id: f9ca9de5-9e31-460d-ac81-368f4e7c8fc0 + name: Small Incredible Wooden Soap + discountAllocations: [] + payments: + - id: defdceb6-83a3-4b7d-a74e-e9ef947d5f48 + amount: 12 + currency: CAD + type: Paypal + status: Unknown + dueDate: '2021-04-04T03:00:14' + createdDate: '2021-03-28T03:00:14' + modifiedDate: '2022-02-02T11:02:45' + serviceCharges: + - description: Service Charge + totalAmount: 1.2 + taxPercentage: 20 + taxAmount: 0.2 + taxes: + - taxComponentRef: + id: '72' + name: Service Tax + taxAmount: '' + quantity: 1 + type: Generic + locationRef: + id: 47bbffc7-c045-4b0f-a3bb-ecf1f669edfa + customerRef: + id: 2634d180-7205-43f0-a73d-84af6443a005 + name: Emmy Roberts + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-28T03:00:14' + type: object + CommerceOrders: + title: 'Commerce: Orders' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceOrder' + - $ref: '#/components/schemas/PagingInfo' + CommercePayment: + title: 'Commerce: Payment' + description: |- + Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status. + + Refunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`. + + You can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR). + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + description: Payment Amount (including gratuity) + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentStatus: + type: string + x-internal: true + description: Status of the payment. + enum: + - Pending + - Authorized + - Paid + - Failed + - Cancelled + - Unknown + paymentType: + type: string + x-internal: true + nullable: true + description: Type of payment. + enum: + - Cash + - Card + - Invoice + - OnlineCard + - Swish + - Vipps + - Mobile + - StoreCredit + - Paypal + - Custom + - Prepaid + - Unknown + example: Cash + paymentRef: + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + nullable: true + description: Payment Amount (including gratuity). + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made. + type: + $ref: '#/components/schemas/CommercePayment/definitions/paymentType' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethod: + title: 'Commerce: Payment method' + description: A Payment Method represents the payment method(s) used to make payments. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the PaymentMethod + example: Alipay + status: + description: Status of the Payment Method. + x-internal: true + type: string + enum: + - Unknown + - Active + - Archived + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethods: + title: 'Commerce: Payment methods' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePaymentMethod' + - $ref: '#/components/schemas/PagingInfo' + CommercePayments: + title: 'Commerce: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePayment' + - $ref: '#/components/schemas/PagingInfo' + CommerceProduct: + title: 'Commerce: Product' + description: | + A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the product in the commerce or POS system + examples: + - Hard Drive + - Windows Installation + - Software Support (Hourly) + description: + type: string + description: Description of the product recorded in the commerce or point of sale platform. + examples: + - 1tb Western Digital Hard Drive + - Install of Windows 11 (Professional Edition) + - 1 hour of support from an agent (phone or remote) + categorization: + type: string + description: Retail category that the product is assigned to e.g. `Hardware`. + examples: + - Hardware + - Software + - Support Services + isGiftCard: + type: boolean + description: | + Whether the product represents a gift card or voucher that + can be redeemed in the commerce or POS platform. + variants: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariant' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + definitions: + productRef: + type: object + description: Reference that links the line item to the correct product details. + properties: + id: + description: The unique identifier of the product being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product being referenced. + type: string + required: + - id + productVariant: + title: Product Variant + description: | + Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + description: 'Identifier of the product variant, unique to the company.' + - properties: + name: + type: string + examples: + - Red Coat + - Black Coat + - Large Brown Hat + description: Name of the product recorded in the commerce or point of sale platform. + isTaxEnabled: + type: boolean + description: Whether sales taxes are enabled for this product variant. + sku: + type: string + examples: + - Coat-Red-Lrg + - Coat-Black-Md + - LargeBrownHat + - A725BA2 + description: 'SKU (stock keeping unit) of the variant, as defined by the merchant.' + barcode: + type: string + examples: + - '564158468416486458646886484' + - CSE370 + description: 'Unique product number of the variant. This might be a barcode, UPC, ISBN, etc.' + unitOfMeasure: + type: string + examples: + - kg + - m + - meters + description: 'Unit of measure for the variant, such as `kg` or `meters`.' + vatPercentage: + type: number + format: decimal + examples: + - 12.5 + - 0 + - 20 + description: VAT rate for the product variant if sales taxes are enabled. + prices: + type: array + description: Prices for the product variants in different currencies. + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productPrice' + inventory: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventory' + shippingRequired: + type: boolean + description: Indicates whether or not the product requires physical delivery. + status: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + productVariantRef: + title: Product variant reference + type: object + description: Reference that links the line item to the specific version of product that has been ordered. + properties: + id: + description: The unique identifier of the product variant being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product variant being referenced. + type: string + required: + - id + productPrice: + title: Product Price Variant + x-internal: true + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + nullable: true + unitPrice: + type: number + format: decimal + description: The product variant's unit price. + productInventory: + title: Product Inventory + description: Information about the total inventory as well as the locations inventory is in. + x-internal: true + type: object + properties: + totalQuantity: + type: number + format: decimal + nullable: true + description: The total quantity of stock remaining across locations. + locations: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventoryLocation' + productInventoryLocation: + title: Product Inventory Location + x-internal: true + type: object + properties: + quantity: + type: number + format: decimal + description: The quantity of stock remaining at location. + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + productVariantStatus: + x-internal: true + type: string + description: The status of the product variant. + enum: + - Unknown + - Published + - Unpublished + CommerceProductCategories: + title: 'Commerce: Product categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProductCategory' + - $ref: '#/components/schemas/PagingInfo' + CommerceProductCategory: + title: 'Commerce: Product category' + description: 'Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.' + type: object + allOf: + - type: object + properties: + id: + type: string + example: '"102"' + description: The unique identifier of the product category + name: + type: string + example: Entertainment + description: The name of the product category + ancestorRefs: + type: array + description: A collection of parent product categories implicitly ordered with the immediate parent last in the list. + items: + $ref: '#/components/schemas/CommerceRecordRef' + hasChildren: + type: boolean + description: A boolean indicating whether there are other product categories beneath this one in the hierarchy. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: + - productCategories: + - id: '100' + name: Entertainment + ancestorRefs: [] + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:53:21Z' + - id: '101' + name: Cinema + ancestorRefs: + - id: '100' + name: Entertainment + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:55:02Z' + - id: '102' + name: Movie + ancestorRefs: + - id: '100' + name: Entertainment + - id: '101' + name: Cinema + hasChildren: false + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-12-25T12:00:00Z' + CommerceProducts: + title: 'Commerce: Products' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProduct' + - $ref: '#/components/schemas/PagingInfo' + CommerceRecordRef: + title: Record Ref + x-internal: true + type: object + properties: + id: + description: The unique identitifer of the record being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + type: + description: The type of record being referenced. + type: string + required: + - id + - type + description: '' + CommerceReport: + title: Commerce report + description: |- + ## Structure + + Assess reports follow a consistent structure. Reports contain four sections of information: + + ### 1. Report definition + + Information such as: + + 1. The report info (e.g. enhanced_profit_and_loss). + 2. The display name of the report (e.g. Enhanced Profit and Loss). + + ### 2. Dimension info + + Information about the dimension contained in the reports such as: + + 1. The type of dimension (e.g. datetime, recordRef). + 2. The display name of the dimension (e.g. Period, Category type, Category sub type). + 3. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"..."). + + ### 3. Measure info + + Information about the measures contained in the report such as: + + 1. The display name of the measure (e.g. value of account, percentage change). + 2. The type of the measure (e.g. currency, percentage). + 3. The unit of the measure (e.g. %, GBP). + + ### 4. The data for the report + + When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*. + + + ## Displaying the report + + Reports can be rendered as follows (ordering is implicit rather than explicit): + + ![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png) + + # Data model + + ## Dimensions + type: object + properties: + reportInfo: + type: object + additionalProperties: + type: string + dimensions: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportDimension' + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportMeasure' + reportData: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + errors: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportError' + definitions: + commerceReportMeasure: + title: Measure + type: object + properties: + displayName: + description: The measure's display name. + type: string + units: + type: string + description: The measure's units e.g. percentage (%). + index: + type: integer + description: The measure's index. + type: + type: string + description: The measure's type. + commerceReportError: + title: Error + type: object + properties: + message: + type: string + description: Message returned by error. + type: + type: string + description: The type of error. + details: + description: Additional details on the error. + type: object + additionalProperties: + type: array + items: + type: string + commerceReportDimension: + title: Dimension + type: object + properties: + index: + type: integer + description: The dimension's index. + displayName: + type: string + description: The dimension's display name. + type: + type: string + description: The dimension's type. + items: + type: array + items: + type: object + properties: + index: + type: integer + description: The dimension's items index. + commerceReportComponent: + title: Report component + type: object + properties: + dimension: + type: integer + description: The component's dimension. + dimensionDisplayName: + type: string + description: The component's display name. + item: + type: integer + description: The component's item number. + itemDisplayName: + type: string + description: The component's item display name. + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/reportComponentMeasure' + components: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + reportComponentMeasure: + type: object + title: Report component measure + properties: + index: + type: integer + description: The measure's index. + measureDisplayName: + type: string + description: The measure's display name. + value: + type: number + format: decimal + description: The measure's value. + x-examples: + Example 1: + reportInfo: + additionalProp1: string + additionalProp2: string + additionalProp3: string + dimensions: + - index: 0 + displayName: string + type: string + items: + - index: 0 + measures: + - displayName: string + units: string + index: 0 + type: string + reportData: + - dimension: 0 + dimensionDisplayName: string + item: 0 + itemDisplayName: string + measures: + - index: 0 + measureDisplayName: string + components: + - string + errors: + - message: string + type: DatesOutOfRange + details: + additionalProp1: + - string + additionalProp2: + - string + additionalProp3: + - string + CommerceTaxComponent: + title: 'Commerce: Tax component' + description: 'The Tax Components endpoints return tax rates data from the commerce software, including tax rate names and values. This is to support the mapping of tax rates from the commerce software to those in the accounting software.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the Tax Rate Component in the source commerce software. + example: Sales Tax + rate: + description: Rate of taxation represented as a fraction of the net price (typically in the range 0.00 - 1.00). + type: number + format: decimal + examples: + - 0.15 + - 0.2 + isCompound: + description: The Boolean flag to indicate when a Tax Rate Component compounds on a sale. + type: boolean + examples: + - true + - false + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - name + definitions: + taxComponentAllocation: + title: Tax Component Allocation + type: object + properties: + taxComponentRef: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentRef' + rate: + description: Tax amount on order line sale as available from source commerce software. + type: number + format: decimal + nullable: true + taxComponentRef: + type: object + description: Taxes rates reference object depending on the rates being available on source commerce software. + properties: + id: + description: The unique identitifer of the tax component being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the tax component being referenced. + type: string + required: + - id + - name + examples: + - id: 13d946f0-c5d5-42bc-b092-97ece17923ab + name: Sales Tax (15%) + rate: 0.15 + isCompound: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + CommerceTransaction: + title: 'Commerce: Transaction' + description: |- + Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees. + + You can use data from the Transactions endpoints to calculate key metrics, such as: + - Transaction volumes + - Average transaction volume + - Average transaction value + - Returns + - Payouts + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + totalAmount: + description: The total transaction amount + type: number + format: decimal + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionType' + subType: + description: Non-standardised transaction type data from the commerce software + type: string + examples: + - CardPayment + - Invoice payment + transactionSourceRef: + description: Link to the source event which triggered this transaction + allOf: + - $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - allOf: + - type: object + x-stoplight: + id: c590b4405180f + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - type: object + x-stoplight: + id: gdyjg7bg783br + properties: + sourceCreatedDate: + $ref: '#/components/schemas/DateTime' + description: The date on which this record was created in the originating system + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + x-stoplight: + id: 9e815c1766554 + definitions: + transactionSourceRef: + title: Transaction Source Reference + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceRecordRef' + - type: object + properties: + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceType' + transactionSourceType: + x-internal: true + type: string + description: The type of source the transaction arose. + enum: + - Fee + - Order + - Payment + - ServiceCharge + - Unknown + transactionType: + x-internal: true + description: |- + The type of the platform transaction: + - `Unknown` + - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account. + - `Payment` — Credit and debit card payments. + - `PaymentFee` — Payment provider's fee on each card payment. + - `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller. + - `Payout` — Transfer of funds from the seller's merchant account to their bank account. + - `Refund` — Refunds to a customer's credit or debit card. + - `Transfer` — Secure transfer of funds to the seller's bank account. + type: string + enum: + - Payment + - Refund + - Payout + - FailedPayout + - Transfer + - PaymentFee + - PaymentFeeRefund + - Unknown + examples: [] + CommerceTransactions: + title: 'Commerce: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceTransaction' + - $ref: '#/components/schemas/PagingInfo' + Companies: + title: Companies + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Company' + - $ref: '#/components/schemas/PagingInfo' + Company: + title: Company + description: "\uFEFFIn Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.\n\nTypically each company is one of your customers.\n\nWhen you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company." + type: object + allOf: + - $ref: '#/components/schemas/Company/definitions/companyDetails' + - type: object + properties: + dataConnections: + type: array + items: + $ref: '#/components/schemas/Connection' + definitions: + companyDetails: + title: Company details + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + type: string + description: The name of the company + example: Codat Ltd. + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + nullable: true + redirect: + type: string + format: uri + description: '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.' + example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + createdByUserName: + type: string + description: Name of user that created the company in Codat. + nullable: true + products: + type: array + items: + type: string + description: An array of products that are currently enabled for the company. + tags: + title: Tags + type: object + maxProperties: 10 + propertyNames: + pattern: '^.{1,27}$' + additionalProperties: + type: string + maxLength: 100 + description: A collection of user-defined key-value pairs that store custom metadata against the company. + referenceParentCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + nullable: true + description: The parent entity or controlling organization of this company. Null if the company has no parent. + referenceSubsidiaryCompanies: + type: array + nullable: false + description: A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + minItems: 0 + items: + $ref: '#/components/schemas/Company/definitions/companyReference' + required: + - id + - name + - redirect + companyReference: + title: Company reference + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' + description: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' + links: + type: object + description: A collection of links for the company. + properties: + portal: + type: string + format: uri + description: Link to the company page in the portal. + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + examples: + - 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 + products: + - spend-insights + - lending + CompanyRequestBody: + title: Create company request + x-internal: true + type: object + properties: + name: + type: string + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + type: string + example: Requested early access to the new financing scheme. + description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + required: + - name + CompanyUpdateRequest: + title: Update company request + x-internal: true + type: object + properties: + name: + type: string + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + Connection: + title: Connection + description: "\uFEFFA connection represents a [company's](https://docs.codat.io/lending-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.\n\nA company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:\n\n- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.\n- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.\n- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.\nAny combination of accounting, banking, and commerce data connections is allowed.\n\nBefore you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview)." + type: object + properties: + id: + $ref: '#/components/parameters/connectionId/schema' + integrationId: + type: string + format: uuid + example: fd321cb6-7963-4506-b873-e99593a45e30 + description: A Codat ID representing the integration. + integrationKey: + type: string + description: 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. + sourceId: + type: string + format: uuid + example: 35b92968-9851-4095-ad60-395c95cbcba4 + description: '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`.' + sourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + platformName: + type: string + description: Name of integration connected to company. + linkUrl: + type: string + format: uri + description: The link URL your customers can use to authorize access to their business application. + example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' + status: + $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + dataConnectionErrors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Connection/definitions/dataConnectionError' + connectionInfo: + type: object + nullable: true + additionalProperties: true + additionalProperties: false + required: + - id + - integrationId + - integrationKey + - sourceId + - platformName + - linkUrl + - status + - created + - sourceType + definitions: + dataConnectionStatus: + title: Data connection status + description: The current authorization status of the data connection. + type: string + enum: + - PendingAuth + - Linked + - Unlinked + - Deauthorized + dataConnectionError: + title: Data connection error + type: object + properties: + statusCode: + type: string + description: The HTTP status code returned by the source platform when the error occurred. + statusText: + type: string + description: A non-numeric status code/text returned by the source platform when the error occurred. + errorMessage: + type: string + description: A message about a error returned by Codat. + erroredOnUtc: + $ref: '#/components/schemas/DateTime' + status: + title: Error status + description: The current status of a transient error. Null statuses indicate that the error is not transient. + type: string + nullable: true + enum: + - Active + - Resolved + resolvedOnUtc: + description: The datetime in Utc that the error was resolved. + nullable: true + $ref: '#/components/schemas/DateTime' + dataConnectionSourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + example: + 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 + Connections: + title: Connections + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Connection' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityDetail: + title: Data integrity detail + type: object + properties: + id: + type: string + description: ID GUID of the transaction. + type: + type: string + description: The data type of the record. + connectionId: + type: string + format: uuid + description: ID GUID representing the connection of the accounting or banking platform. + readOnly: true + date: + $ref: '#/components/schemas/DateTime' + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: number + format: decimal + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + matches: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail/definitions/dataIntegrityMatch' + definitions: + dataIntegrityMatch: + type: object + properties: + id: + type: string + description: ID GUID of the transaction. + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + connectionId: + type: string + description: ID GUID representing the connection of the accounting or banking platform. + format: uuid + date: + type: string + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: string + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + DataIntegrityDetails: + title: Data integrity details + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityStatus: + title: Data integrity status + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + statusInfo: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityStatusInfo' + connectionIds: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityConnectionId' + amounts: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityAmounts' + dates: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityDates' + definitions: + dataIntegrityStatusInfo: + type: object + properties: + lastMatched: + type: string + $ref: '#/components/schemas/DateTime' + description: The date the matching algorithm last ran against the company’s data type specified. + readOnly: true + currentStatus: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/integrityStatus' + statusMessage: + type: string + description: Detailed explanation supporting the status value. + dataIntegrityConnectionId: + type: object + properties: + source: + type: array + description: An array of strings. The connection IDs for the type specified in the url. + items: + type: string + target: + type: array + description: An array of strings. The connection IDs for the type being matched to. + items: + type: string + dataIntegrityAmounts: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + min: + type: number + format: decimal + description: Lowest value of transaction set. + max: + type: number + format: decimal + description: Highest value of transaction set. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityDates: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + minDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date of transaction set. + readOnly: true + maxDate: + $ref: '#/components/schemas/DateTime' + description: Latest date of transaction set. + readOnly: true + minOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date where transactions exist in both accounting and banking platforms. + readOnly: true + maxOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Latest date where transactions exist in both account and banking platforms. + readOnly: true + integrityStatus: + type: string + enum: + - Unknown + - DoesNotExist + - Error + - Complete + description: The current status of the most recently run matching algorithm. + examples: + - type: string + statusInfo: + lastMatched: '2021-10-24T14:15:22Z' + currentStatus: Unknown + statusMessage: string + connectionIds: + source: + - d5a8d1b2-b38a-4e44-8641-548ad43be6bb + - da8c9f39-8af9-4a98-964b-f1e207942837 + target: + - 3d7ce25a-c107-44bc-8e0c-36c10bdd14e0 + - a5300eac-01fa-4a77-b5b0-ea0b86a3be69 + amounts: + min: 130 + max: 2450 + currency: GBP + dates: + minDate: '2021-09-17T12:09:33.441Z' + maxDate: '2021-12-16T12:12:53.441Z' + minOverlappingDate: '2021-09-30T12:09:13.441Z' + maxOverlappingDate: '2021-11-27T12:19:33.441Z' + DataIntegrityStatuses: + title: Data integrity statuses + x-internal: true + type: object + properties: + metadata: + type: array + items: + $ref: '#/components/schemas/DataIntegrityStatus' + DataIntegritySummaries: + title: Data integrity summaries + x-internal: true + type: object + properties: + summaries: + type: array + items: + $ref: '#/components/schemas/DataIntegritySummary' + DataIntegritySummary: + title: Data integrity summary + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + byAmount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByAmount' + byCount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByCount' + definitions: + dataIntegrityType: + type: object + properties: + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + dataIntegrityByAmount: + title: Data integrity by amount + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of the absolute value of transactions of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityByCount: + title: Data integrity by count + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of records of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The number of records of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The number of records of the type specified in the route which do have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + DataStatus: + title: Data status + description: Describes the state of data in the Codat cache for a company and data type + type: object + required: + - dataType + - currentStatus + properties: + dataType: + title: Data types + x-internal: true + type: string + description: Available data types + enum: + - accountTransactions + - balanceSheet + - bankAccounts + - bankTransactions + - billCreditNotes + - billPayments + - bills + - cashFlowStatement + - chartOfAccounts + - company + - creditNotes + - customers + - directCosts + - directIncomes + - invoices + - itemReceipts + - items + - journalEntries + - journals + - paymentMethods + - payments + - profitAndLoss + - purchaseOrders + - salesOrders + - suppliers + - taxRates + - trackingCategories + - transfers + - banking-accountBalances + - banking-accounts + - banking-transactionCategories + - banking-transactions + - commerce-companyInfo + - commerce-customers + - commerce-disputes + - commerce-locations + - commerce-orders + - commerce-paymentMethods + - commerce-payments + - commerce-productCategories + - commerce-products + - commerce-taxComponents + - commerce-transactions + example: invoices + lastSuccessfulSync: + $ref: '#/components/schemas/DateTime' + currentStatus: + $ref: '#/components/schemas/PullOperation/properties/status' + latestSyncId: + type: string + description: Unique identifier for most recent sync of data type. + format: uuid + example: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: + type: string + description: Unique identifier for the most recent successful sync of data type. + format: uuid + example: 8220fc90-55b6-47bc-9417-48ac6ea93101 + examples: + - dataType: string + lastSuccessfulSync: '2022-01-01T13:00:00.000Z' + currentStatus: string + latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 + DataStatusResponse: + x-internal: true + title: Data status response + type: object + additionalProperties: + $ref: '#/components/schemas/DataStatus' + DataType: + x-internal: true + $ref: '#/components/schemas/DataStatus/properties/dataType' + DateTime: + title: Date time + type: string + examples: + - '2022-10-23T00:00:00Z' + - '2022-10-23' + description: |- + 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. + EndUploadSessionRequest: + title: End upload session request + type: object + properties: + status: + type: string + enum: + - Cancel + - Process + description: An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. + EnhancedCashFlowTransactions: + title: Enhanced cash flow transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + dataSources: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/dataSource' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem' + definitions: + dataSource: + type: object + properties: + accounts: + description: 'An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.' + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts' + accounts: + title: Accounts + type: object + properties: + sourceRef: + title: Report source reference + description: A source reference containing the `sourceType` object "Banking". + type: object + properties: + sourceType: + description: The data source type. + type: string + examples: + - Example: + value: + sourceRef: + sourceType: Banking + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + enhancedCashFlowItem: + type: object + properties: + transactions: + description: An array of transaction data. + type: array + items: + title: Cash flow transaction + type: object + properties: + id: + description: The unique identifier of the bank transaction. + type: string + date: + description: The date the bank transaction was posted. + $ref: '#/components/schemas/DateTime' + description: + description: The description of the bank transaction. + type: string + amount: + description: The bank transaction amount. + type: number + format: decimal + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for bank transaction. + transactionCategory: + description: Contains an array of category levels. + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/transactionCategory' + platformName: + description: Returns the payment processor responsible for the transaction. + type: string + counterpartyNames: + description: An array of counterparty names involved in the transaction. + type: array + items: + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + accountRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/accountRef' + modifiedDate: + description: The date the bank transaction was last modified. + $ref: '#/components/schemas/DateTime' + isRecurring: + description: Indicates if the transaction is classified as recurring by Codat's categorization engine. + type: boolean + nullable: true + definitions: + accountRef: + title: Account reference + description: An account reference containing the account id and name. + type: object + properties: + id: + description: The id of the account. + type: string + name: + description: The name of the account. + type: string + examples: + - Example: + value: + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + transactionCategory: + title: Transaction category + type: object + properties: + confidence: + description: Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100. + type: number + format: decimal + confidences: + description: An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array. + type: array + items: + type: number + format: decimal + levels: + description: The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). + type: array + items: + type: string + examples: + - Example: + value: + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + - BankTransfers + - ShareholderTransfers + confidences: + - 92.7 + - 95 + - 96 + - 97.5 + - 100 + examples: + - reportInfo: + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + reportName: Cash Flow transactions report + companyName: Example Company + generatedDate: '2023-01-25T22:36:05.125Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Current Account + accountType: Debit + currency: USD + currentBalance: 1000 + identifiers: + - type: Debit + subType: Current + number: 12345678 + bankCode: 123456 + iban: US123456789 + bic: US123456789 + maskedAccountNumber: 1234 + - sourceRef: + sourceType: Banking + id: 12345678-1234-1234-1234-123456789012 + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Saving Account + accountType: Debit + currency: USD + currentBalance: 5321 + identifiers: + - type: Debit + subType: Saving + number: 87654321 + bankCode: 654321 + iban: US987654321 + bic: US987654321 + maskedAccountNumber: 4321 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: null + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + EnhancedFinancialReport: + title: Enhanced report + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportInfo' + reportItems: + type: array + description: An array of report items. + items: + title: Report item + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Last date of the period. + balance: + type: number + format: decimal + description: Balance of the account as reported on the profit and loss or Balance sheet. + accountName: + type: string + description: Name of the account. + accountId: + type: string + description: The unique account ID. + accountCategory: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportAccountCategory' + definitions: + enhancedReportAccountCategory: + title: Account category + descrciption: 'An object containing the suggested or confirmed account categories, up to five levels.' + type: object + properties: + status: + type: string + description: 'Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned.' + levels: + type: array + items: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/accountCategoryLevel' + accountCategoryLevel: + title: Account category level + description: An object containing an ordered list of account category levels. + type: object + properties: + levelName: + type: string + description: Account category name. + confidence: + type: number + format: decimal + description: Confidence level of the category. This will only be populated where `status` is `Suggested`. + enhancedReportInfo: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the P&L/Balance sheet. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + examples: + - reportInfo: + reportName: EnhancedProfitAndLossAccounts + companyName: ABC LTD + generatedDate: '2022-01-01' + reportItems: + - date: '2022-01-01' + balance: 70 + accountName: Sales UK + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 30 + accountName: Sales US + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 70 + accountName: Amazon + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.95 + - levelName: Online + confidence: 0.8 + EnhancedInvoicesReport: + title: Enhanced invoices report + description: The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by matching with the bank statement. + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/enhancedInvoiceReportItem' + definitions: + lendingCustomerRef: + type: object + properties: + id: + minLength: 1 + type: string + description: '`id` from the Customers data type.' + customerName: + type: string + nullable: true + description: '`customerName` from the Customer data type.' + payment: + title: Enhanced invoice payment item + type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + date: + $ref: '#/components/schemas/DateTime' + paymentType: + type: string + description: The type of payment. + amount: + type: number + format: decimal + description: Payment amount. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + bankingTransactionRefs: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/bankingTransactionRef' + bankingTransactionRef: + title: Banking transaction reference + type: object + properties: + id: + type: string + description: Unique identifier for the bank transaction. + dataConnectionId: + type: string + description: Unique identifier of the bank transaction's connection. + accountId: + type: string + description: Unique identifier of the bank transaction's account. + accountName: + type: string + description: Name given to account. + date: + $ref: '#/components/schemas/DateTime' + description: + type: string + description: Description given to bank transaction. + amount: + type: number + description: Bank transaction amount. + format: decimal + invoiceStatus: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + enhancedInvoiceReportItem: + title: Enhanced invoice report item + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + invoiceNumber: + type: string + description: Invoice number. + customerRef: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/lendingCustomerRef' + issueDate: + $ref: '#/components/schemas/DateTime' + dueDate: + $ref: '#/components/schemas/DateTime' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + totalAmount: + type: number + format: decimal + description: Invoice's total amount. + amountDue: + type: number + format: decimal + description: Invoice's total amount due. + payments: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/payment' + paidOnDate: + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + reportInfo: + title: Report information + type: object + description: 'Report additional information, which is specific to Lending reports.' + properties: + pageNumber: + type: integer + description: The number of the page queried. + pageSize: + type: integer + description: The number of transactions returned per page. + totalResults: + type: integer + description: The total number of transactions available for a company for the period specified in the query string. + reportName: + type: string + description: Name of the report. + companyName: + type: string + description: The name of the company being queried. + generatedDate: + type: string + description: Date the report was generated. + examples: + - Example 1: + value: + pageNumber: 0 + pageSize: 0 + totalResults: 0 + reportName: string + companyName: string + generatedDate: '2023-01-26T07:36:40.487Z' + ErrorMessage: + title: Error message + type: object + x-internal: true + properties: + statusCode: + type: integer + description: The HTTP status code returned by the error. + service: + type: string + description: Codat's service the returned the error. + error: + type: string + description: A brief description of the error. + correlationId: + type: string + description: Unique identifier used to propagate to all downstream services and determine the source of the error. + validation: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidation' + canBeRetried: + type: string + description: '`True` if the error occurred transiently and can be retried.' + detailedErrorCode: + type: integer + description: Machine readable error code used to automate processes based on the code returned. + definitions: + errorValidation: + title: Validation error + type: object + nullable: true + description: 'A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.' + properties: + errors: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + warnings: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + errorValidationItem: + title: Validation error item + type: object + properties: + itemId: + type: string + nullable: true + description: Unique identifier for a validation item. + message: + type: string + nullable: true + description: A message outlining validation item's issue. + validatorName: + type: string + nullable: true + description: Name of validator. + ExcelStatus: + type: object + title: Excel status + properties: + lastGenerated: + $ref: '#/components/schemas/DateTime' + description: The date and time of when the generation of the most recent report was initiated. + inProgress: + type: boolean + description: 'When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.' + queued: + type: string + description: The date and time of when a successful request was queued for the most recent report. + success: + type: boolean + description: True if the requested report was successfully queued and false if the requested report was not able to be queued. + errorMessage: + type: string + description: Error details in case the report generation request was unsuccessful. + lastInvocationId: + type: string + description: A unique ID generated for this request. + reportType: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + fileSize: + type: integer + nullable: true + description: The file size in Bytes is populated upon successful generation of the report. + definitions: + excelReportTypes: + type: string + enum: + - audit + - enhancedFinancials + - enhancedInvoices + - enhancedCashFlow + description: The type of the report requested in the query string. + examples: + - lastGenerated: '2023-01-25T22:36:05.125Z' + inProgress: true + queued: '2023-01-25T22:36:05.125Z' + success: true + errorMessage: string + lastInvocationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + reportType: string + fileSize: 0 + File: + title: File + type: object + properties: + fileName: + type: string + nullable: true + description: The file's name. + displayName: + type: string + nullable: true + description: An optional display name for the file. + sourceType: + type: string + nullable: true + description: The source of the file uploaded. + uploaded: + $ref: '#/components/schemas/DateTime' + additionalProperties: false + Files: + title: Files + type: array + items: + $ref: '#/components/schemas/File' + FileUpload: + title: Attachment upload + type: object + x-internal: true + required: + - file + properties: + file: + $ref: '#/components/schemas/FileUpload/definitions/codatFile' + definitions: + codatFile: + type: string + description: The file to be uploaded as an attachment. + format: binary + FinancialSummary: + title: Closed Books Indicator + type: object + properties: + booksClosedDate: + type: object + description: The date time in UTC the books closed. + properties: + date: + type: string + format: date-time + description: The date time in UTC the books closed. + example: '2025-05-31T00:00:00Z' + reason: + type: array + description: List of reasons explaining the books closed date. + items: + type: string + example: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + type: object + description: 'A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.' + properties: + score: + type: number + format: decimal + description: The accounting score value. + example: 90 + reason: + type: array + description: List of reasons explaining the accounting score. + items: + type: string + example: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + LoanSummary: + title: Loan summary + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportInfo' + reportItems: + type: array + description: Returns a summary of all loan activity for that integration type + items: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportItem' + definitions: + loanSummaryReportInfo: + title: Loan Summary Report Info + type: object + properties: + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. urns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + x-stoplight: + id: vrnhmgrfndjhh + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + loanSummaryRecordRef: + title: Item reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + integrationType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryIntegrationType' + recordRefType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRefType' + loanSummaryReportItem: + type: object + properties: + recordRef: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRef' + description: Contains object that contains a summary of all loan transactions for that integration type. + description: + type: string + description: The description of the object being referred to. E.g. the account. + startDate: + $ref: '#/components/schemas/DateTime' + description: The date of the earliest loan transaction. + totalDrawdowns: + type: number + format: decimal + description: The total loan drawdowns. + totalRepayments: + type: number + format: decimal + description: The total loan repayments which includes capital plus any interest. + balance: + type: number + format: decimal + description: The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. + lender: + type: string + description: The name of lender providing the loan. + loanSummaryIntegrationType: + title: Integration type + type: string + enum: + - Accounting + - Banking + - Commerce + description: The integration type begin referred to. + loanSummaryRecordRefType: + title: Record reference type + type: string + enum: + - accounts + - banking-accounts + - commerce-transactions + description: The datatype being referred to. + examples: + - reportInfo: + reportName: LoanSummaryReport + companyName: The Coffee shop + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - recordRef: + id: string + dataConnectionId: DE34E8E3-089F-4DF4-89E9-F7C43618FCAAA + integrationType: Accounting + recordRefType: accounts + description: string + startDate: '2021-01-01' + totalInvestments: 100000 + totalRepayments: 83481.72 + balance: 42513.18 + lender: Barclays Bank + LoanTransactions: + title: Loan transactions + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanTransactions/definitions/loanTransactionsReportInfo' + reportItems: + type: array + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + items: + $ref: '#/components/schemas/LoanTransactions/definitions/reportItems' + definitions: + loanTransactionsReportInfo: + title: Loan Transactions Report Info + type: object + properties: + pageNumber: + type: integer + description: The page number. + pageSize: + type: integer + description: Queried page size. + totalResults: + type: integer + description: The total number of transactions returned. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + itemRef: + title: Item reference + type: object + properties: + id: + type: string + description: 'The id of the object, e.g. the Journal entry.' + dataConnectionId: + type: string + description: The data connection id being referenced. + type: + type: string + description: The data type the loan transaction entry was extracted from. + reportItems: + type: object + properties: + loanRef: + $ref: '#/components/schemas/LoanTransactions/definitions/loanRef' + description: Contains object that contains all the Loan transactions for that integration type. + itemRef: + $ref: '#/components/schemas/LoanTransactions/definitions/itemRef' + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + date: + $ref: '#/components/schemas/DateTime' + description: The date of that entry type occurred. + amount: + type: number + format: decimal + description: The loan transaction amount. + loanTransactionType: + description: The type of loan transaction. + type: string + enum: + - Investment + - Repayment + - Interest + - AccuredInterest + lender: + type: string + description: The name of lender providing the loan. + examples: + - reportInfo: + pageNumber: 1 + pageSize: 1000 + totalResults: 1 + reportName: AccountingLoanTransactions + companyName: Supermarket store + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - loanRef: + id: '332' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: chartOfAccount + itemRef: + id: '755488' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: journalEntry + date: '2020-08-02' + amount: -455 + transactionType: Repayment + lender: Barclays Bank + Metadata: + title: Metadata + type: object + x-internal: true + properties: + isDeleted: + type: boolean + description: Indicates whether the record has been deleted in the third-party system this record originated from. + nullable: true + PagingInfo: + type: object + title: Pagination information + x-internal: true + properties: + pageNumber: + type: integer + description: Current page number. + pageSize: + type: integer + description: Number of items to return in results array. + maximum: 2000 + totalResults: + type: integer + description: Total number of items. + _links: + $ref: '#/components/schemas/PagingInfo/definitions/links' + definitions: + links: + title: Hal Links + type: object + required: + - self + - current + properties: + self: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + current: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + next: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + previous: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + examples: + - self: + href: /companies + current: + href: /companies?page=1&pageSize=10 + halRef: + title: Hypertext reference + type: object + properties: + href: + type: string + format: uri-reference + description: Uri hypertext reference. + required: + - pageNumber + - pageSize + - totalResults + - _links + examples: + - pageNumber: 1 + pageSize: 10 + totalResults: 1 + _links: + self: + href: '/companies/{id}/data/{dataType}' + current: + href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + PaymentMethodRef: + type: object + title: Payment method reference + description: The payment method the record is linked to in the accounting or commerce software. + properties: + id: + description: The unique identifier of the location being referenced. + type: string + name: + description: Name of the location being referenced. + type: string + required: + - id + example: + id: EILBDVJVNUAGVKRQ + name: AliPay + PhoneNumber: + title: Phone + type: object + x-internal: true + properties: + number: + type: string + nullable: true + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + description: A phone number. + type: + description: The type of phone number + type: string + enum: + - Primary + - Landline + - Mobile + - Fax + - Unknown + required: + - type + ProjectRef: + title: 'Accounting: Project reference' + x-internal: true + required: + - id + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the project reference. + name: + type: string + nullable: true + description: The project's name. + PullOperation: + title: Pull operation + description: |- + Information about a queued, in progress or completed pull operation. + *Formally called `dataset`* + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier of the pull operation. + example: 943accd0-4247-42d8-865b-363c8629e1da + companyId: + type: string + format: uuid + description: Unique identifier of the company associated to this pull operation. + example: 22ece347-e5f6-4896-95e0-35a4c7f17023 + connectionId: + type: string + format: uuid + description: Unique identifier of the connection associated to this pull operation. + example: 50830828-7d39-4367-b0eb-5ddb2de5faa5 + dataType: + title: Data types + x-internal: true + type: string + description: The data type you are requesting in a pull operation. + status: + title: Dataset status + type: string + description: The current status of the dataset. + enum: + - Initial + - Queued + - Fetching + - MapQueued + - Mapping + - Complete + - FetchError + - MapError + - InternalError + - ProcessingQueued + - Processing + - ProcessingError + - ValidationQueued + - Validating + - ValidationError + - AuthError + - Cancelled + - NotSupported + - RateLimitError + - PermissionsError + - PrerequisiteNotMet + statusDescription: + type: string + nullable: true + description: Additional information about the dataset status. + example: 'Paused until 2022-10-23T00:00:00.000Z' + errorMessage: + type: string + nullable: true + description: A message about a transient or persistent error returned by Codat or the source platform. + requested: + $ref: '#/components/schemas/DateTime' + completed: + $ref: '#/components/schemas/DateTime' + progress: + type: integer + description: An integer signifying the progress of the pull operation. + isCompleted: + type: boolean + description: '`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: + type: boolean + description: '`True` if the pull operation entered an error state.' + required: + - id + - companyId + - connectionId + - dataType + - status + - requested + - progress + - isCompleted + - isErrored + examples: + - 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 + PullOperations: + title: Pull operations + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/PullOperation' + - $ref: '#/components/schemas/PagingInfo' + PushOperation: + title: Push operation + type: object + x-internal: true + properties: + changes: + type: array + nullable: true + description: 'Contains a single entry that communicates which record has changed and the manner in which it changed. ' + items: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationChange' + dataType: + $ref: '#/components/schemas/DataStatus/properties/dataType' + description: 'The type of data being pushed, eg invoices, customers.' + companyId: + $ref: '#/components/parameters/companyId/schema' + pushOperationKey: + type: string + format: uuid + description: '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.' + dataConnectionKey: + $ref: '#/components/parameters/connectionId/schema' + requestedOnUtc: + $ref: '#/components/schemas/DateTime' + description: The datetime when the push was requested. + completedOnUtc: + $ref: '#/components/schemas/DateTime' + description: 'The datetime when the push was completed, null if Pending.' + timeoutInMinutes: + type: integer + format: int32 + nullable: true + description: Number of minutes the push operation must complete within before it times out. + timeoutInSeconds: + type: integer + format: int32 + nullable: true + deprecated: true + description: Number of seconds the push operation must complete within before it times out. + status: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationStatus' + errorMessage: + type: string + nullable: true + description: A message about the error. + validation: + $ref: '#/components/schemas/PushOperation/definitions/validation' + statusCode: + type: integer + description: Push status code. + required: + - companyId + - pushOperationKey + - dataConnectionKey + - requestedOnUtc + - status + - statusCode + definitions: + validation: + type: object + title: Validation + description: '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.' + properties: + errors: + type: array + nullable: true + items: + $ref: '#/components/schemas/PushOperation/definitions/validationItem' + warnings: + type: array + nullable: true + items: + $ref: '#/components/schemas/PushOperation/definitions/validationItem' + validationItem: + title: Validation item + type: object + properties: + itemId: + type: string + nullable: true + description: Unique identifier for a validation item. + message: + type: string + nullable: true + description: A message outlining validation item's issue. + validatorName: + type: string + nullable: true + description: Name of validator. + additionalProperties: false + pushChangeType: + title: Push change type + description: Type of change being applied to record in third party platform. + type: string + enum: + - Unknown + - Created + - Modified + - Deleted + - AttachmentUploaded + pushOperationRef: + title: Push operation reference + x-internal: true + type: object + properties: + id: + type: string + description: Unique identifier for a push operation. + dataType: + $ref: '#/components/schemas/DataStatus/properties/dataType' + nullable: true + additionalProperties: false + pushOperationStatus: + title: Push operation status + type: string + enum: + - Pending + - Failed + - Success + - TimedOut + description: The current status of the push operation. + pushOperationChange: + type: object + properties: + type: + $ref: '#/components/schemas/PushOperation/definitions/pushChangeType' + recordRef: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationRef' + attachmentId: + type: string + description: Unique identifier for the attachment created otherwise null. + nullable: true + PushOperations: + title: Push operations + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/PushOperation' + - $ref: '#/components/schemas/PagingInfo' + PushOption: + title: Push option + x-internal: true + required: + - displayName + - required + - type + type: object + properties: + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName' + description: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' + required: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty' + nullable: true + options: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushOptionChoice' + nullable: true + validation: + $ref: '#/components/schemas/PushOption/definitions/pushValidationInfo' + nullable: true + definitions: + pushOptionProperty: + title: Push Option Property + required: + - description + - displayName + - required + - type + type: object + properties: + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + minLength: 1 + type: string + description: The property's display name. + description: + type: string + description: A description of the property. + required: + type: boolean + description: The property is required if `True`. + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty' + nullable: true + options: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushOptionChoice' + nullable: true + validation: + $ref: '#/components/schemas/PushOption/definitions/pushValidationInfo' + pushValidationInfo: + title: Push validation info + type: object + properties: + warnings: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushFieldValidation' + nullable: true + information: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushFieldValidation' + nullable: true + additionalProperties: false + pushFieldValidation: + title: Push field validation + required: + - details + type: object + properties: + field: + type: string + description: Field name that resulted in the validation issue. + details: + minLength: 1 + type: string + description: Details on the validation issue. + ref: + type: string + format: uri + nullable: true + description: Unique reference identifier for the validation issue. + additionalProperties: false + pushOptionType: + title: Option Type + description: The option type. + enum: + - Array + - Object + - String + - Number + - Boolean + - DateTime + - File + - MultiPart + type: string + pushOptionChoice: + title: Push Option Choice + type: object + properties: + value: + type: string + minLength: 1 + description: Allowed value for field. + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName' + description: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' + required: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + ReportLine: + x-internal: true + type: object + title: 'Accounting: Report line' + properties: + accountId: + type: string + nullable: true + description: 'Identifier for the account, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the report line item. + value: + type: number + format: decimal + description: Numerical value of the line item. + items: + type: array + nullable: true + description: An array of ReportLine items. + items: + $ref: '#/components/schemas/ReportLine' + required: + - value + ReportOperation: + title: Report + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier of the report + example: 52c0f26b-051a-43ff-b02a-258eec67f5ef + status: + type: string + enum: + - InProgress + - Complete + - Error + description: The status of the report generation. + type: + type: string + enum: + - categorizedBankStatement + - creditModel + - spendAnalysis + description: The name of the generated report. + requestedDate: + description: The date and time on which the report was requested. + $ref: '#/components/schemas/DateTime' + updatedDate: + description: The date and time on which the report was last updated. + $ref: '#/components/schemas/DateTime' + errorMessage: + type: string + nullable: true + description: A short message describing any errors that occurred while generating the report. + description: Information about report generation. + definitions: + reports: + title: Reports + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/ReportOperation' + minLength: 0 + maxLength: 2000 + - $ref: '#/components/schemas/PagingInfo' + SourceAccount: + title: Source account (v1) + type: object + description: The target bank account in a supported accounting software for ingestion into a bank feed. + additionalProperties: false + properties: + id: + type: string + description: Unique ID for the bank account. + accountName: + type: string + nullable: true + description: The bank account name. + accountType: + type: string + nullable: true + description: The type of bank account e.g. Credit. + accountNumber: + type: string + nullable: true + description: The account number. + sortCode: + type: string + nullable: true + description: The sort code. + currency: + title: Currency + x-internal: true + type: string + description: |- + 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. + format: ISO4217 + examples: + - GBP + - USD + - EUR + balance: + type: number + format: decimal + nullable: true + description: The latest balance for the bank account. + modifiedDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The last date the bank account was modified. + status: + type: string + nullable: true + description: Status of the source account. + enum: + - pending + - connected + - connecting + - disconnected + - unknown + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + required: + - id + definitions: + sourceAccountPrototype: + title: Source account (v1) + type: object + properties: + id: + $ref: '#/components/schemas/SourceAccount/properties/id' + accountName: + $ref: '#/components/schemas/SourceAccount/properties/accountName' + accountType: + $ref: '#/components/schemas/SourceAccount/properties/accountType' + accountNumber: + $ref: '#/components/schemas/SourceAccount/properties/accountNumber' + sortCode: + $ref: '#/components/schemas/SourceAccount/properties/sortCode' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + balance: + $ref: '#/components/schemas/SourceAccount/properties/balance' + modifiedDate: + $ref: '#/components/schemas/SourceAccount/properties/modifiedDate' + required: + - id + sourceAccounts: + title: Source accounts + type: array + items: + $ref: '#/components/schemas/SourceAccount' + examples: + - id: acc-002 + accountName: account-081 + sortCode: '123456' + accountType: Credit + accountNumber: '12345670' + currency: GBP + balance: 99.99 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + status: pending + - id: acc-003 + accountName: account-095 + sortCode: '123456' + accountType: Credit + accountNumber: '12345671' + currency: USD + balance: 0 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + status: pending + SourceAccountV2: + title: Source account (v2) + type: object + description: The target bank account in a supported accounting software for ingestion into a bank feed. + additionalProperties: false + properties: + id: + type: string + description: Unique ID for the bank account. + accountName: + type: string + description: The bank account name. + accountType: + type: string + description: 'The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.' + enum: + - checking + - savings + - loan + - creditCard + - prepaidCard + accountNumber: + type: string + description: The account number. + sortCode: + type: string + nullable: true + description: The sort code. + routingInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + balance: + type: number + format: decimal + description: The latest balance for the bank account. + accountInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' + modifiedDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The last date the bank account was modified. + status: + type: string + nullable: true + description: Status of the source account. + enum: + - pending + - connected + - connecting + - disconnected + - unknown + feedStartDate: + nullable: true + title: Date + type: string + example: '2022-10-23' + description: |- + In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example: + ``` + 2020-10-08 + ``` + required: + - id + - accountName + - accountType + - accountNumber + - currency + - balance + definitions: + sourceAccountV2Prototype: + title: Source account (v2) + type: object + properties: + id: + $ref: '#/components/schemas/SourceAccountV2/properties/id' + accountName: + $ref: '#/components/schemas/SourceAccountV2/properties/accountName' + accountType: + $ref: '#/components/schemas/SourceAccountV2/properties/accountType' + accountNumber: + $ref: '#/components/schemas/SourceAccountV2/properties/accountNumber' + routingInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' + sortCode: + $ref: '#/components/schemas/SourceAccountV2/properties/sortCode' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + balance: + $ref: '#/components/schemas/SourceAccountV2/properties/balance' + modifiedDate: + $ref: '#/components/schemas/SourceAccountV2/properties/modifiedDate' + accountInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' + required: + - id + - accountName + - accountType + - accountNumber + - currency + - balance + accountInfo: + title: Account Info + type: object + nullable: true + properties: + description: + type: string + nullable: true + description: Description of the account. + nickname: + type: string + nullable: true + description: Name given to the account by the user. Used in UIs to assist in account selection. + accountOpenDate: + $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' + nullable: true + description: Date when the account was opened or created at the provider + availableBalance: + type: number + format: decimal + nullable: true + description: Balance of funds available for use. This includes pending activity. + sourceAccounts: + title: Source accounts + type: array + items: + $ref: '#/components/schemas/SourceAccountV2' + routingInfo: + title: Routing Info + type: object + description: Routing information for the bank. This does not include account number. + properties: + bankCode: + type: string + nullable: true + description: The numeric identifier of the routing number + type: + type: string + nullable: true + default: bankcode + enum: + - rtn + - aba + - swift + - bsb + - iban + - nz2 + - trno + - sortcode + - blz + - ifsc + - bankcode + - apca + - clabe + description: The type of routing number. + examples: + - id: acc-001 + accountName: account-081 + accountType: checking + accountNumber: '12345670' + routingInfo: + bankCode: 021001088 + type: bankcode + currency: GBP + balance: 99.99 + accountInfo: + description: account description 1 + nickname: account 123 + accountOpenDate: '2023-05-06' + availableBalance: 10 + modifiedDate: '2024-08-02T00:00:00.000Z' + status: pending + feedStartDate: '2024-05-01' + - id: acc-002 + accountName: account-083 + accountType: savings + accountNumber: '23456789' + routingInfo: + bankCode: 021001088 + type: bankcode + currency: GBP + balance: 400 + accountInfo: + description: account description 2 + nickname: account 1290 + accountOpenDate: '2023-05-23' + availableBalance: 400 + modifiedDate: '2024-08-02T00:00:00.000Z' + status: pending + feedStartDate: '2024-05-01' + StartUploadSessionRequest: + title: Upload session start request + type: object + properties: + dataType: + type: string + enum: + - banking-accounts + - banking-transactions + description: A key for a Codat data type. + SupplementalData: + title: Supplemental data + type: object + x-internal: true + description: |- + 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. + properties: + content: + type: object + additionalProperties: + type: object + additionalProperties: true + nullable: true + ThirdPartySchema: + title: Third-party schema + description: The format should be identical to the file format receieved from the third-party banking source (e.g. Plaid or TrueLayer). + type: object + x-speakeasy-type-override: any + WebLink: + title: Weblink + description: Weblink associated with the company. + type: object + properties: + type: + description: The type of the weblink. + type: string + enum: + - Website + - Social + - Unknown + url: + description: The full URL for the weblink. + type: string + format: url + example: + type: Website + url: 'https://codat.io' + parameters: + page: + name: page + in: query + schema: + type: integer + format: int32 + minimum: 1 + example: 1 + default: 1 + description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' + pageSize: + name: pageSize + in: query + schema: + type: integer + format: int32 + default: 100 + example: 100 + minimum: 1 + maximum: 5000 + description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' + query: + name: query + in: query + required: false + schema: + type: string + example: id=e3334455-1aed-4e71-ab43-6bccf12092ee + description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' + orderBy: + name: orderBy + in: query + required: false + schema: + type: string + example: '-modifiedDate' + description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' + companyId: + name: companyId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId + in: path + required: true + schema: + type: string + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. + dataType: + name: dataType + description: A key for a Codat data type. + in: path + required: true + schema: + $ref: '#/components/schemas/DataType' + datasetId: + name: datasetId + in: path + required: true + schema: + type: string + format: uuid + description: Unique identifier for the dataset that completed its sync. + description: Unique identifier for the dataset that completed its sync. + dataIntegrityDataType: + name: dataType + in: path + required: true + schema: + type: string + enum: + - banking-accounts + - banking-transactions + - bankAccounts + - accountTransactions + example: banking-accounts + description: A key for a Codat data type. + reportDate: + name: reportDate + in: query + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + reportDateRequired: + name: reportDate + in: query + required: true + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + periodLength: + name: periodLength + in: query + required: true + schema: + type: integer + description: The number of months per period. E.g. 2 = 2 months per period. + numberOfPeriods: + name: numberOfPeriods + in: query + required: false + schema: + type: integer + description: 'The number of periods to return. If not provided, 12 periods will be used as the default value.' + numberOfPeriodsRequired: + name: numberOfPeriods + in: query + required: true + schema: + type: integer + description: The number of periods to return. There will be no pagination as a query parameter. + periodUnit: + name: periodUnit + in: query + required: true + schema: + type: string + enum: + - Day + - Week + - Month + - Year + description: The period unit of time returned. + includeDisplayNames: + name: includeDisplayNames + in: query + schema: + type: boolean + description: Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. + excelReportType: + name: reportType + in: query + schema: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + description: The type of report you want to generate and download. + required: true + accountingAccountId: + name: accountId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an account. + accountingBillPaymentId: + name: billPaymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill payment. + accountingBillId: + name: billId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill. + attachmentId: + name: attachmentId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for an attachment. + accountingDirectCostId: + name: directCostId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct cost. + accountingDirectIncomeId: + name: directIncomeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct income. + accountingInvoiceId: + name: invoiceId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an invoice. + accountingSupplierId: + name: supplierId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a supplier. + accountingReportDate: + name: reportDate + in: query + schema: + type: string + format: date + example: '2022-12-31' + description: Date the report is generated up to. + accountingNumberOfPeriods: + name: numberOfPeriods + in: query + schema: + type: integer + format: int32 + example: 12 + description: Number of periods to include in the report. + accountingPeriodLengthDays: + name: periodLengthDays + in: query + schema: + type: integer + format: int32 + example: 30 + description: The length of period in days. + accountingPeriodLength: + name: periodLength + description: Number of months defining the period of interest. + in: query + required: true + schema: + type: integer + format: int32 + example: 4 + accountingPeriodsToCompare: + name: periodsToCompare + description: Number of periods with `periodLength` to compare. + in: query + required: true + schema: + type: integer + format: int32 + example: 20 + accountingStartMonth: + name: startMonth + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: The month the report starts from. + customerId: + name: customerId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a customer. + timeoutInMinutes: + name: timeoutInMinutes + in: query + schema: + type: integer + format: int32 + description: Time limit for the push operation to complete before it is timed out. + allowSyncOnPushComplete: + name: allowSyncOnPushComplete + in: query + schema: + type: boolean + default: true + description: Allow a sync upon push completion. + forceUpdate: + name: forceUpdate + in: query + schema: + type: boolean + default: false + description: '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.' + pushOperationKey: + name: pushOperationKey + schema: + type: string + format: uuid + in: path + required: true + description: Unique identifier for the push operation. + paymentId: + name: paymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment. + productId: + name: productId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a product. + path: + name: path + description: The endpoint path of the third-party banking service that the request body originates from. Only required if the source is not `codat`. + in: query + required: false + schema: + type: string + enum: + - auth/get + reportType: + name: reportType + description: The type of the report + in: path + required: true + schema: + type: string + enum: + - categorizedBankStatement + - creditModel + reportId: + name: reportId + description: 'Unique identifier for a report, use either the Id of the report or `latest` for the most recently generate report.' + in: path + required: true + schema: + oneOf: + - type: string + title: ID + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + - type: string + title: Latest + enum: + - latest + maxAge: + description: The maximum age of report to fetch. + name: maxAge + in: query + required: false + schema: + $ref: '#/components/schemas/DateTime' + responses: + BadRequest: + description: The request made is not valid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Malformed query: + value: + statusCode: 400 + service: PublicApi + error: Error processing request - not valid. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Malformed-Query: + description: Your `query` parameter was not correctly formed + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Malformed query: + value: + statusCode: 400 + service: ClientsApi + error: Error parsing query - Malformed query. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Unresolved property: + value: + statusCode: 400 + service: PullApi + error: Error parsing query - Could not resolve property isCompleted on Dataset + correlationId: 98457fb9956b7f9b4b2fd4f6e23bb5c8 + canBeRetried: Unknown + detailedErrorCode: 0 + Unauthorized: + description: Your API request was not properly authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Unauthorized: + value: + statusCode: 401 + service: PublicApi + error: Unauthorized + correlationId: 7eb40d6b415d7bcd99ce658268284056 + canBeRetried: Unknown + detailedErrorCode: 0 + Payment-Required: + description: | + An account limit has been exceeded. The type of limit is described in the error property: + + - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. + - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. + - Your Free account is older than 365 days and has expired. Contact support@codat.io. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 429 + service: PublicApi + error: You have exceeded the 50-company limit that applies to a Free plan. We recommend that you delete any companies you no longer need and retry the request. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Forbidden: + description: You are using an outdated API key or a key not associated with that resource. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 403 + service: PublicApi + error: You are using an outdated API key or a key not associated with that resource. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Not-Found: + description: |- + One or more of the resources you referenced could not be found. + This might be because your company or data connection id is wrong, or was already deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Data connection not found: + value: + statusCode: 404 + service: PublicApi + error: Data connection a22dd66b-564a-4832-9b37-7b3ce4aeb7de not found + correlationId: 8fa2b5f4794970a4ee73758f612e8df0 + canBeRetried: Unknown + detailedErrorCode: 0 + Company not found: + value: + statusCode: 404 + service: ClientsApi + error: No company was found with ID 846ed55c-974b-4392-a1f1-87b6fdbf3c5e + correlationId: 0a40c2f31fc8f992fb88b0853e4166f3 + canBeRetried: Unknown + detailedErrorCode: 0 + No data available: + value: + statusCode: 404 + service: PublicApi + error: No data available for accounts for ID e5889b459f544926ac5b8e6756df2s + correlationId: 0a40c2f31fc8f992fb88b0853e4166f3 + canBeRetried: Unknown + detailedErrorCode: 0 + Conflict: + description: The data type's dataset has not been requested or is still syncing. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 409 + service: PublicApi + error: The data set has not been requested. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Too-Many-Requests: + description: Too many requests were made in a given amount of time. Wait a short period and then try again. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 429 + service: PublicApi + error: You have made too many requests in a given amount of time; please retry later. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Internal-Server-Error: + description: There is a problem with our server. Please try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 500 + service: PublicApi + error: There is a problem with our server. Please try again later. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Service-Unavailable: + description: The Codat API is temporarily offline for maintenance. Please try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 500 + service: PublicApi + error: The Codat API is temporarily offline for maintenance. Please try again later. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + securitySchemes: + auth_header: + name: Authorization + description: 'The word "Basic" followed by a space and your API key. [API keys](https://docs.codat.io/platform-api#/schemas/ApiKeyDetails) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/platform-api#/operations/list-api-keys), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.' + type: apiKey + in: header + x-speakeasy-example: Basic BASE_64_ENCODED(API_KEY) + examples: + CodatBankStatementUploadConfiguration: + value: + source: codat + accountId: abc123-ABC + summary: Settings for uploading codat data + EnhancedCashflowExample: + value: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 2194 + reportName: Cash flow transactions report + companyName: test + generatedDate: '2023-03-24T16:44:17.5302732Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + SingleReportExample: + value: + id: 6e9bae88-72c9-45ae-abe8-41fbf2871458 + status: InProgress + type: categorizedBankStatement + requestedDate: '2024-09-27T04:43:41Z' + updatedDate: '2024-10-01T14:41:46Z' diff --git a/.speakeasy/logs/changes/old.openapi.yaml b/.speakeasy/logs/changes/old.openapi.yaml new file mode 100644 index 000000000..747aeacf1 --- /dev/null +++ b/.speakeasy/logs/changes/old.openapi.yaml @@ -0,0 +1,85028 @@ +openapi: 3.1.0 +servers: + - description: Production + url: 'https://api.codat.io' +info: + title: Lending + description: |- + Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. + + The Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers. + + [Explore solution](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + + + ## Endpoints + + | Endpoints | Description | + | :- |:- | + | Companies | Create and manage your SMB users' companies. | + | Connections | Create new and manage existing data connections for a company. | + | Bank statements | Retrieve banking data from linked bank accounts. | + | Sales | Retrieve standardized sales data from a linked commerce software. | + | Financial statements | Financial data and reports from a linked accounting software. | + | Liabilities | Debt and other liabilities. | + | Accounts payable | Data from a linked accounting software representing money the business owes money to its suppliers. | + | Accounts receivable | Data from a linked accounting software representing money owed to the business for sold goods or services. | + | Transactions | Data from a linked accounting software representing transactions. | + | Company info | View company information fetched from the source platform. | + | Data integrity | Match mutable accounting data with immutable banking data to increase confidence in financial data. | + | Excel reports | Download reports in Excel format. | + | Manage data | Control how data is retrieved from an integration. | + | File upload | Endpoints to manage uploaded files. | + | Loan writeback | Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. | + + version: 3.0.0 + contact: + name: Codat + email: support@codat.io + termsOfService: 'https://www.codat.io/legals/' +security: + - auth_header: [] +x-speakeasy-retries: + strategy: backoff + backoff: + initialInterval: 500 + maxInterval: 60000 + maxElapsedTime: 3600000 + exponent: 1.5 + statusCodes: + - 408 + - 429 + - 5XX + retryConnectionErrors: true +x-speakeasy-name-override: + - operationId: ^list-.*? + methodNameOverride: list + - operationId: ^list-.*?-attachments + methodNameOverride: list-attachments + - operationId: ^get-.*? + methodNameOverride: get + - operationId: ^get-create-.*?-model + methodNameOverride: get-create-model + - operationId: ^get-create-update.*?-model + methodNameOverride: get-create-update-model + - operationId: ^get-.*?-attachment + methodNameOverride: get-attachment + - operationId: ^update-.*? + methodNameOverride: update + - operationId: ^create-.*? + methodNameOverride: create + - operationId: ^delete-.*? + methodNameOverride: delete + - operationId: ^delete-.*?-attachment + methodNameOverride: delete-attachment + - operationId: ^download-.*?-attachment + methodNameOverride: download-attachment + - operationId: ^upload-.*?-attachment + methodNameOverride: upload-attachment +x-codat-docs-path: lending-api +x-codat-keep-docs-paths-local: true +x-codat-speakeasy-pagination: + type: offsetLimit + inputs: + - name: page + in: parameters + type: page + outputs: + results: $.results +tags: + - name: Companies + description: Create and manage your SMB users' companies. + - name: Connections + description: Create new and manage existing data connections for a company. + - name: Bank statements + description: Retrieve banking data from linked bank accounts. + - name: Sales + description: Retrieve standardized sales data from a linked commerce software. + - name: Financial statements + description: Financial data and reports from a linked accounting software. + - name: Liabilities + description: Debt and other liabilities. + - name: Accounts payable + description: Data from a linked accounting software representing money the business owes money to its suppliers. + - name: Accounts receivable + description: Data from a linked accounting software representing money owed to the business for sold goods or services. + - name: Accounting bank data + description: Access bank transactions from an accounting software. + - name: Transactions + description: Data from a linked accounting software representing transactions. + - name: Company info + description: View company information fetched from the source platform. + - name: Data integrity + description: Match mutable accounting data with immutable banking data to increase confidence in financial data. + - name: Excel reports + description: Download reports in Excel format. + - name: Manage data + description: Control how data is retrieved from an integration. + - name: File upload + description: Endpoints to manage uploaded files. + - name: Loan writeback + description: 'Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle.' + - name: Manage reports + description: Generate and review generated reports for a company. + - name: Financial summary + description: 'View financial summary information for a company, including credit model reports and accounting score.' +paths: + /companies: + get: + summary: List companies + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Companies' + examples: + One company: + value: + results: + - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + name: My Test Company + description: My Test Company make testing software + platform: '' + redirect: 'https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6' + lastSync: '2022-01-01T12:30:00.000Z' + dataConnections: + - id: 51baa045-4836-4317-a42e-3542e991e581 + integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 + integrationKey: vjms + sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b + platformName: Pandle + linkUrl: 'https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-01-01T11:30:00Z' + createdByUserName: Mike Smith + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: [] + pageNumber: 1 + pageSize: 100 + totalResults: 1 + _links: + current: + href: /companies?page=1&pageSize=100 + self: + href: /companies + List of Companies: + value: + results: + - id: d1568dde-adf6-11ed-afa1-0242ac120002 + name: Technicalium + description: 'Technology services, including web and app design and development' + platform: '' + redirect: 'https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002' + lastSync: '2022-01-01T12:30:00.000Z' + dataConnections: + - id: 51baa045-4836-4317-a42e-3542e991e581 + integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 + integrationKey: vjms + sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b + platformName: Pandle + linkUrl: 'https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-01-01T11:30:00Z' + createdByUserName: Joe Bloggs + products: + - spend-insights + - lending + - payables-v2 + referenceSubsidiaryCompanies: [] + - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceSubsidiaryCompanies: + - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + links: + portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + links: + portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' + - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' + dataConnections: + - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - lending + - spend-insights + - payables + referenceParentCompany: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + redirect: 'https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913' + dataConnections: + - id: 1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/connections/1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceParentCompany: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + pageNumber: 1 + pageSize: 100 + totalResults: 3 + _links: + current: + href: /companies?page=1&pageSize=100 + self: + href: /companies + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-companies + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x61\x73\x73\x6F\x63\x69\x61\x74\x65\x64\x20\x74\x6F\x20\x79\x6F\x75\x72\x20\x69\x6E\x73\x74\x61\x6E\x63\x65\x73\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x23\x23\x20\x46\x69\x6C\x74\x65\x72\x20\x62\x79\x20\x74\x61\x67\x73\n\n\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x73\x75\x70\x70\x6F\x72\x74\x73\x20\x74\x68\x65\x20\x66\x69\x6C\x74\x65\x72\x69\x6E\x67\x20\x6F\x66\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x20\x75\x73\x69\x6E\x67\x20\x5B\x74\x61\x67\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x6D\x61\x6E\x61\x67\x69\x6E\x67\x2D\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x23\x61\x64\x64\x2D\x6D\x65\x74\x61\x64\x61\x74\x61\x2D\x74\x6F\x2D\x61\x2D\x63\x6F\x6D\x70\x61\x6E\x79\x29\x2E\x20\x49\x74\x20\x73\x75\x70\x70\x6F\x72\x74\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x6F\x70\x65\x72\x61\x74\x6F\x72\x73\x20\x77\x69\x74\x68\x20\x5B\x43\x6F\x64\x61\x74\u2019\x73\x20\x71\x75\x65\x72\x79\x20\x6C\x61\x6E\x67\x75\x61\x67\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x71\x75\x65\x72\x79\x69\x6E\x67\x29\x3A\n\n\x2D\x20\x65\x71\x75\x61\x6C\x73\x20\x28\x60\x3D\x60\x29\n\x2D\x20\x6E\x6F\x74\x20\x65\x71\x75\x61\x6C\x73\x20\x28\x60\x21\x3D\x60\x29\n\x2D\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x28\x60\x7E\x60\x29\n\n\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x74\x68\x65\x20\x71\x75\x65\x72\x79\x69\x6E\x67\x20\x74\x6F\x20\x66\x69\x6C\x74\x65\x72\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x20\x74\x61\x67\x67\x65\x64\x20\x77\x69\x74\x68\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x66\x6F\x72\x65\x69\x67\x6E\x20\x6B\x65\x79\x2C\x20\x72\x65\x67\x69\x6F\x6E\x2C\x20\x6F\x72\x20\x6F\x77\x6E\x69\x6E\x67\x20\x74\x65\x61\x6D\x3A\x20\n\x2D\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x6B\x65\x79\x3A\x20\x60\x75\x69\x64\x20\x3D\x20\x7B\x79\x6F\x75\x72\x43\x75\x73\x74\x6F\x6D\x65\x72\x49\x64\x7D\x60\n\x2D\x20\x52\x65\x67\x69\x6F\x6E\x3A\x20\x60\x72\x65\x67\x69\x6F\x6E\x20\x21\x3D\x20\x75\x6B\x60\n\x2D\x20\x4F\x77\x6E\x69\x6E\x67\x20\x74\x65\x61\x6D\x20\x61\x6E\x64\x20\x72\x65\x67\x69\x6F\x6E\x3A\x20\x60\x72\x65\x67\x69\x6F\x6E\x20\x3D\x20\x75\x6B\x20\x26\x26\x20\x6F\x77\x6E\x69\x6E\x67\x54\x65\x61\x6D\x20\x3D\x20\x69\x6E\x76\x6F\x69\x63\x65\x2D\x66\x69\x6E\x61\x6E\x63\x65\x60" + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + - name: tags + in: query + schema: + type: string + example: region=uk && team=invoice-finance + description: 'Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying).' + post: + summary: Create company + tags: + - Companies + operationId: create-company + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/Company' + examples: + With no description: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceSubsidiaryCompanies: [] + With a description: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium + description: 'Technology services, including web and app design and development' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + referenceSubsidiaryCompanies: [] + With a tag: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + tags: + region: us + referenceSubsidiaryCompanies: [] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x6E\x65\x77\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x74\x68\x61\x74\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x69\x6E\x20\x43\x6F\x64\x61\x74\x2E\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x49\x66\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x28\x73\x65\x65\x20\x60\x6E\x61\x6D\x65\x60\x20\x70\x61\x74\x74\x65\x72\x6E\x29\x20\x61\x72\x65\x20\x70\x72\x65\x73\x65\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x71\x75\x65\x73\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x72\x65\x6D\x6F\x76\x65\x64\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x28\x43\x6F\x64\x61\x74\x5B\x31\x5D\x29\x60\x20\x77\x69\x74\x68\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x61\x73\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x43\x6F\x64\x61\x74\x31\x60\x2E" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyRequestBody' + examples: + With no description: + value: + name: Technicalium + With a description: + value: + name: Technicalium + description: 'Technology services, including web and app design and development' + '/companies/{companyId}': + put: + summary: Replace company + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x52\x65\x70\x6C\x61\x63\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x72\x65\x70\x6C\x61\x63\x65\x20\x74\x68\x65\x20\x65\x78\x69\x73\x74\x69\x6E\x67\x20\x6E\x61\x6D\x65\x2C\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x2C\x20\x61\x6E\x64\x20\x74\x61\x67\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x43\x61\x6C\x6C\x69\x6E\x67\x20\x74\x68\x65\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x77\x69\x6C\x6C\x20\x72\x65\x70\x6C\x61\x63\x65\x20\x65\x78\x69\x73\x74\x69\x6E\x67\x20\x76\x61\x6C\x75\x65\x73\x20\x65\x76\x65\x6E\x20\x69\x66\x20\x6E\x65\x77\x20\x76\x61\x6C\x75\x65\x73\x20\x68\x61\x76\x65\x6E\x27\x74\x20\x62\x65\x65\x6E\x20\x64\x65\x66\x69\x6E\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6C\x6F\x61\x64\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" + operationId: replace-company + x-speakeasy-name-override: replace + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Company' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyRequestBody' + examples: + Update name: + value: + name: New Name + Update description: + value: + name: Same name + description: Additional documents required + patch: + summary: Update company + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x75\x70\x64\x61\x74\x65\x20\x74\x68\x65\x20\x6E\x61\x6D\x65\x2C\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x2C\x20\x6F\x72\x20\x74\x61\x67\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x64\x6F\x65\x73\x6E\x27\x74\x20\x68\x61\x76\x65\x20\x61\x6E\x79\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x66\x69\x65\x6C\x64\x73\x2E\x20\x49\x66\x20\x61\x6E\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x66\x69\x65\x6C\x64\x73\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x61\x72\x65\x20\x60\x6E\x75\x6C\x6C\x60\x20\x6F\x72\x20\x6E\x6F\x74\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2C\x20\x74\x68\x65\x79\x20\x77\x6F\x6E\x27\x74\x20\x62\x65\x20\x69\x6E\x63\x6C\x75\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x70\x64\x61\x74\x65\x2E\x20\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E" + operationId: update-company + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Company' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyUpdateRequest' + examples: + Update tags: + value: + tags: + refrence: new reference + Update name: + value: + name: New Name + delete: + summary: Delete a company + operationId: delete-company + parameters: + - $ref: '#/components/parameters/companyId' + description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x65\x6C\x65\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x65\x72\x6D\x61\x6E\x65\x6E\x74\x6C\x79\x20\x64\x65\x6C\x65\x74\x65\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x2C\x20\x69\x74\x73\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x61\x6E\x64\x20\x61\x6E\x79\x20\x63\x61\x63\x68\x65\x64\x20\x64\x61\x74\x61\x2E\x20\x54\x68\x69\x73\x20\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x20\x69\x73\x20\x69\x72\x72\x65\x76\x65\x72\x73\x69\x62\x6C\x65\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" + tags: + - Companies + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + get: + summary: Get company + operationId: get-company + description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x60\x63\x6F\x6D\x70\x61\x6E\x79\x49\x64\x60\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Companies + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Company' + examples: + Simple company: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores holdings + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: [] + Parent multi-entity company: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: + - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + links: + portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + links: + portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' + Subsidiary multi-entity company: + value: + id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + description: '' + platform: '' + redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' + dataConnections: + - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + sourceType: Accounting + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceParentCompany: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections': + get: + summary: List connections + description: "\uFEFF\x4C\x69\x73\x74\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" + operationId: list-connections + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connections' + examples: + Connections: + value: + results: + - 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 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + _links: + self: + href: string + current: + href: string + next: + href: string + previous: + href: string + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + summary: Create connection + description: "\uFEFF\x43\x72\x65\x61\x74\x65\x73\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x62\x79\x20\x70\x72\x6F\x76\x69\x64\x69\x6E\x67\x20\x61\x20\x76\x61\x6C\x69\x64\x20\x60\x70\x6C\x61\x74\x66\x6F\x72\x6D\x4B\x65\x79\x60\x2E\x20\n\n\x55\x73\x65\x20\x74\x68\x65\x20\x5B\x4C\x69\x73\x74\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x6C\x69\x73\x74\x2D\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x29\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x61\x63\x63\x65\x73\x73\x20\x76\x61\x6C\x69\x64\x20\x70\x6C\x61\x74\x66\x6F\x72\x6D\x20\x6B\x65\x79\x73\x2E\x20" + parameters: + - $ref: '#/components/parameters/companyId' + tags: + - Connections + operationId: create-connection + requestBody: + content: + application/json: + schema: + type: object + properties: + platformKey: + type: string + minLength: 4 + maxLength: 4 + pattern: '[a-z]{4}' + example: gbol + description: '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.' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: + Connection: + value: + 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 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}': + get: + summary: Get connection + operationId: get-connection + description: "\uFEFF\x52\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x77\x68\x65\x6E\x20\x76\x61\x6C\x69\x64\x20\x69\x64\x65\x6E\x74\x69\x66\x69\x65\x72\x73\x20\x61\x72\x65\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2E\x20\x49\x66\x20\x74\x68\x65\x20\x69\x64\x65\x6E\x74\x69\x66\x69\x65\x72\x73\x20\x61\x72\x65\x20\x66\x6F\x72\x20\x61\x20\x64\x65\x6C\x65\x74\x65\x64\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x61\x6E\x64\x2F\x6F\x72\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2C\x20\x61\x20\x6E\x6F\x74\x20\x66\x6F\x75\x6E\x64\x20\x72\x65\x73\x70\x6F\x6E\x73\x65\x20\x69\x73\x20\x72\x65\x74\x75\x72\x6E\x65\x64\x2E" + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: + Connection: + value: + 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 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + delete: + summary: Delete connection + operationId: delete-connection + description: "\uFEFF\x52\x65\x76\x6F\x6B\x65\x20\x61\x6E\x64\x20\x72\x65\x6D\x6F\x76\x65\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x66\x72\x6F\x6D\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\x54\x68\x69\x73\x20\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x20\x69\x73\x20\x6E\x6F\x74\x20\x72\x65\x76\x65\x72\x73\x69\x62\x6C\x65\x2E\x20\x54\x68\x65\x20\x65\x6E\x64\x20\x75\x73\x65\x72\x20\x77\x6F\x75\x6C\x64\x20\x6E\x65\x65\x64\x20\x74\x6F\x20\x72\x65\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x20\x61\x20\x6E\x65\x77\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x69\x66\x20\x79\x6F\x75\x20\x77\x69\x73\x68\x20\x74\x6F\x20\x76\x69\x65\x77\x20\x6E\x65\x77\x20\x64\x61\x74\x61\x20\x66\x6F\x72\x20\x74\x68\x69\x73\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + tags: + - Connections + responses: + '200': + description: OK + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + patch: + summary: Unlink connection + description: "\uFEFF\x54\x68\x69\x73\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x64\x65\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2C\x20\x77\x69\x74\x68\x6F\x75\x74\x20\x64\x65\x6C\x65\x74\x69\x6E\x67\x20\x69\x74\x20\x66\x72\x6F\x6D\x20\x43\x6F\x64\x61\x74\x2E\x20\x54\x68\x69\x73\x20\x6D\x65\x61\x6E\x73\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x73\x74\x69\x6C\x6C\x20\x76\x69\x65\x77\x20\x61\x6E\x79\x20\x64\x61\x74\x61\x20\x74\x68\x61\x74\x20\x68\x61\x73\x20\x70\x72\x65\x76\x69\x6F\x75\x73\x6C\x79\x20\x62\x65\x65\x6E\x20\x70\x75\x6C\x6C\x65\x64\x20\x69\x6E\x74\x6F\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x6E\x64\x20\x61\x6C\x73\x6F\x20\x6C\x65\x74\x73\x20\x79\x6F\x75\x20\x72\x65\x2D\x61\x75\x74\x68\x6F\x72\x69\x7A\x65\x20\x69\x6E\x20\x66\x75\x74\x75\x72\x65\x20\x69\x66\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x77\x69\x73\x68\x65\x73\x20\x74\x6F\x20\x72\x65\x73\x75\x6D\x65\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E" + operationId: unlink-connection + x-speakeasy-name-override: unlink + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + application/json: + schema: + title: Update connection + x-internal: true + type: object + properties: + status: + $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' + description: The current authorization status of the data connection. + nullable: true + additionalProperties: false + examples: + Example: + value: + status: Unlinked + description: '' + '/companies/{companyId}/data/all': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Refresh all data + operationId: refresh-all-data-types + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: all-data-types + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Refreshes all data types with `fetch on first link` set to `true` for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + + [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. + tags: + - Manage data + '/companies/{companyId}/dataStatus': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get data status + operationId: get-data-status + x-speakeasy-group: manage-data + x-speakeasy-name-override: get-status + description: Get the state of each data type for a company + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + title: Data statuses + x-internal: true + type: object + properties: + accountTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + balanceSheet: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + billCreditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + billPayments: + $ref: '#/components/schemas/DataStatus' + nullable: true + bills: + $ref: '#/components/schemas/DataStatus' + nullable: true + cashFlowStatement: + $ref: '#/components/schemas/DataStatus' + nullable: true + chartOfAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + company: + $ref: '#/components/schemas/DataStatus' + nullable: true + creditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + directCosts: + $ref: '#/components/schemas/DataStatus' + nullable: true + directIncomes: + $ref: '#/components/schemas/DataStatus' + nullable: true + invoices: + $ref: '#/components/schemas/DataStatus' + nullable: true + itemReceipts: + $ref: '#/components/schemas/DataStatus' + nullable: true + items: + $ref: '#/components/schemas/DataStatus' + nullable: true + journalEntries: + $ref: '#/components/schemas/DataStatus' + nullable: true + journals: + $ref: '#/components/schemas/DataStatus' + nullable: true + paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + profitAndLoss: + $ref: '#/components/schemas/DataStatus' + nullable: true + purchaseOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + salesOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + suppliers: + $ref: '#/components/schemas/DataStatus' + nullable: true + taxRates: + $ref: '#/components/schemas/DataStatus' + nullable: true + trackingCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + transfers: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accountBalances: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactionCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-companyInfo: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-disputes: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-locations: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-orders: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-productCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-products: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-taxComponents: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + examples: + Example: + value: + accountTransactions: + dataType: accountTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + balanceSheet: + dataType: balanceSheet + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankAccounts: + dataType: bankAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankTransactions: + dataType: bankTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billCreditNotes: + dataType: billCreditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billPayments: + dataType: billPayments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bills: + dataType: bills + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + cashFlowStatement: + dataType: cashFlowStatement + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + chartOfAccounts: + dataType: chartOfAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + company: + dataType: company + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + creditNotes: + dataType: creditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + customers: + dataType: customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directCosts: + dataType: directCosts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directIncomes: + dataType: directIncomes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + invoices: + dataType: invoices + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + itemReceipts: + dataType: itemReceipts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + items: + dataType: items + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journalEntries: + dataType: journalEntries + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journals: + dataType: journals + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + paymentMethods: + dataType: paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + payments: + dataType: payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + profitAndLoss: + dataType: profitAndLoss + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + purchaseOrders: + dataType: purchaseOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + salesOrders: + dataType: salesOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + suppliers: + dataType: suppliers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + taxRates: + dataType: taxRates + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + trackingCategories: + dataType: trackingCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + transfers: + dataType: transfers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accountBalances: + dataType: banking-accountBalances + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accounts: + dataType: banking-accounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactionCategories: + dataType: banking-transactionCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactions: + dataType: banking-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-companyInfo: + dataType: commerce-companyInfo + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-customers: + dataType: commerce-customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-disputes: + dataType: commerce-disputes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-locations: + dataType: commerce-locations + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-orders: + dataType: commerce-orders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-paymentMethods: + dataType: commerce-paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-payments: + dataType: commerce-payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-productCategories: + dataType: commerce-productCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-products: + dataType: commerce-products + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-taxComponents: + dataType: commerce-taxComponents + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-transactions: + dataType: commerce-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/queue/{dataType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataType' + post: + summary: Refresh data type + operationId: refresh-data-type + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: data-type + description: |- + Refreshes a given data type for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + tags: + - Manage data + parameters: + - schema: + type: string + format: uuid + in: query + name: connectionId + description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/history': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List pull operations + tags: + - Manage data + operationId: list-pull-operations + x-speakeasy-group: manage-data.pull-operations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperations' + examples: + Example: + value: + results: + - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b + companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 + connectionId: 51baa045-4836-4317-a42e-3542e991e581 + dataType: invoices + status: Initial + requested: '2022-11-14T11:18:37.2798351Z' + progress: 10 + isCompleted: false + isErrored: false + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets the pull operation history (datasets) for a given company. + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/data/history/{datasetId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/datasetId' + get: + summary: Get pull operation + operationId: get-pull-operation + x-speakeasy-group: manage-data.pull-operations + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Retrieve information about a single dataset or pull operation. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity status + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityStatuses' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-status + x-speakeasy-name-override: status + description: |- + The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching. + This endpoint helps you understand whether match data is available and, if so, how to usefully query it. + + The response tells you: + + - Whether match results are available. + - When the results were generated, and their status. + - The connection IDs, amounts, and dates involved to support useful querying. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity summaries + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegritySummaries' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-summaries + x-speakeasy-name-override: summaries + description: "The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). \n\nFor example, if you wanted to see summary match results only for transactions after 1 December 2020, you could include a query parameter of `query=date>2020-12-01`.\n\nThe endpoint response includes only the summary results, not transactions. To view match data for transactions, use the [List data integrity details](https://docs.codat.io/lending-api#/operations/get-data-integrity-summaries) endpoint." + parameters: + - $ref: '#/components/parameters/query' + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: List data integrity details + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityDetails' + examples: {} + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-data-integrity-details + x-speakeasy-name-override: details + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results. + + The [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetail) are paginated and support ordering, following the same conventions as our other data endpoints. + '/companies/{companyId}/reports/enhancedProfitAndLoss/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized profit and loss statement + description: |- + The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedProfitAndLossAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:40:59.0847354Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 830.93 + accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + accountName: Repairs & Maintenance + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 12000 + accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + accountName: Wages + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 28937.71 + accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + accountName: Purchases + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 582.4 + accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + accountName: Purchase Discounts + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 350.44 + accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + accountName: Charitable and Political Donations + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Donations + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 535.81 + accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + accountName: Interest Paid (operating) + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Interest + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 633.05 + accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + accountName: Corporation Tax + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Taxes + confidence: 99.99 + - levelName: CorporationTaxes + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 782.61 + accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + accountName: Bank Fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: BankCharges + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 8000 + accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + accountName: Rent + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: BuildingRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1090.68 + accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + accountName: Motor Vehicle Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: EquipmentRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 26307.02 + accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + accountName: Advertising & Marketing + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1128.85 + accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + accountName: 'Postage, Freight & Courier' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 40 + accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + accountName: Subscriptions + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 5.72 + accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + accountName: Amortization + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Amortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1539.18 + accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + accountName: Depreciation Expense + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Depreciation + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1416.05 + accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + accountName: Entertainment-100% business + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: EmployeeBenefits + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1465.61 + accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + accountName: General Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 7347.35 + accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + accountName: 'Light, Power, Heating' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1027.25 + accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + accountName: Printing & Stationery + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 45 + accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + accountName: Telephone & Internet + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + accountName: Audit & Accountancy fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 130 + accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + accountName: Cleaning + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 860.02 + accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + accountName: Travel - National + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Travel + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 850.22 + accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + accountName: Other Revenue + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Online + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 138457.98 + accountId: 72df89d2-512b-4455-af51-a6b563733842 + accountName: Sales + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Wholesale + confidence: 99.99 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-categorized-profit-and-loss-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/reportDate' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedBalanceSheet/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized balance sheet statement + operationId: get-categorized-balance-sheet-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.balance-sheet + description: |- + The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedBalanceSheetAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:42:09.2973105Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 12973.03 + accountId: 22de1660-d745-4809-a363-16b134607e66 + accountName: Prepayments + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedDeferredAssets + confidence: 99.99 + - levelName: PrepaidExpenses + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 316065.92 + accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + accountName: Business Current Account + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 65945.07 + accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + accountName: Inventory + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 71937.95 + accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + accountName: Accounts Receivable + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Receivables + confidence: 99.99 + - levelName: AccountsReceivables + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2180148.56 + accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + accountName: Office Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1804674.9 + accountId: be3eb911-034b-42de-95db-0d58ac978b7f + accountName: Computer Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 3417424.16 + accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + accountName: Retained Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: RetainedEarnings + confidence: 99.99 + - levelName: CapitalIncomeReserve + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 44252.52 + accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + accountName: Current Year Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: ShareCapital + confidence: 99.99 + - levelName: CommonStock + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 75835.64 + accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + accountName: Accounts Payable + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccountsPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 208264.65 + accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + accountName: Accruals + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedLiabilities + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + accountName: Rounding + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 25184.57 + accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + accountName: Credit Card Control Account + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: CreditCards + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 9650.58 + accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + accountName: Historical Adjustment + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2022.41 + accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + accountName: John Smith + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 29034.75 + accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + accountName: VAT + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1076.55 + accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + accountName: Interest Payables + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + accountName: Unpaid Expense Claims + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 638999.6 + accountId: 55008233-40e7-41ac-84af-2255fa028c2e + accountName: Loan + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedCashFlow/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized bank statement + operationId: get-categorized-bank-statement + x-speakeasy-group: banking.categorized-statement + description: "\uFEFF\x3E\x20\x2A\x2A\x43\x61\x74\x65\x67\x6F\x72\x69\x7A\x61\x74\x69\x6F\x6E\x20\x65\x6E\x67\x69\x6E\x65\x2A\x2A\n\x3E\n\x3E\x20\x54\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x61\x74\x69\x6F\x6E\x20\x65\x6E\x67\x69\x6E\x65\x20\x75\x73\x65\x73\x20\x6D\x61\x63\x68\x69\x6E\x65\x20\x6C\x65\x61\x72\x6E\x69\x6E\x67\x20\x61\x6E\x64\x20\x68\x61\x73\x20\x62\x65\x65\x6E\x20\x66\x75\x6C\x6C\x79\x20\x74\x72\x61\x69\x6E\x65\x64\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x50\x6C\x61\x69\x64\x20\x61\x6E\x64\x20\x54\x72\x75\x65\x4C\x61\x79\x65\x72\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2E\x20\x49\x74\x20\x69\x73\x20\x6E\x6F\x74\x20\x66\x75\x6C\x6C\x79\x20\x74\x72\x61\x69\x6E\x65\x64\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x74\x68\x65\x20\x42\x61\x73\x69\x71\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x2E\n\n\x54\x68\x65\x20\x5F\x47\x65\x74\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x62\x61\x6E\x6B\x20\x73\x74\x61\x74\x65\x6D\x65\x6E\x74\x5F\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x72\x6F\x76\x69\x64\x65\x73\x20\x61\x20\x66\x75\x6C\x6C\x79\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x20\x64\x61\x74\x61\x20\x61\x72\x65\x20\x6F\x62\x74\x61\x69\x6E\x65\x64\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2E" + tags: + - Bank statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCashFlowTransactions' + examples: + Categorized bank statement: + $ref: '#/components/examples/EnhancedCashflowExample' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + '/companies/{companyId}/reports/enhancedInvoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List reconciled invoices + tags: + - Accounts receivable + operationId: list-reconciled-invoices + x-speakeasy-name-override: list-reconciled + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/EnhancedInvoicesReport' + example: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 101 + reportName: Invoices report + companyName: Small Sandbox + generatedDate: '2023-05-10T10:50:23.9437977Z' + reportItems: + - id: 15221fa4-e91a-4f64-a2bb-caeab4db85a4 + invoiceNumber: UDs5KlfE + customerRef: + id: ee4d0eee-063d-4c9f-8226-2c9a6a816249 + customerName: Serena Keeling + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 7044.83 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-02-27T18:28:00' + payments: [] + - id: 58aea1cb-5b31-4eed-ba16-489dfa67a831 + invoiceNumber: 1IU1PMoT + customerRef: + id: 81e9c0df-3e5e-4180-b20c-c8e58100cdf3 + customerName: Quinton Kovacek + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 3567.59 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-06-23T22:47:00' + payments: [] + - id: 9ecd07bc-9cab-4516-bad0-a0cd565cdbaf + invoiceNumber: eEIWyPN4 + customerRef: + id: c7326084-cd56-48e6-bcfa-be8919e024e1 + customerName: Antwon Dach + issueDate: '2021-04-08T01:27:00' + dueDate: '2021-04-18T01:27:00' + status: Paid + currency: GBP + totalAmount: 153233.36 + amountDue: 0 + paidOnDate: '2021-04-10T12:31:00' + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2021-11-11T12:10:00' + payments: + - id: 0878e8be-6746-4347-80ba-5491328c8411 + date: '2021-04-10T12:31:00' + paymentType: payments + amount: 153233.36 + currency: GBP + currencyRate: 1 + - id: 7cea078a-5c9a-4788-ae72-9bb60c5cc184 + invoiceNumber: BXb8mYQW + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-04-16T17:30:00' + dueDate: '2021-04-23T17:30:00' + status: Paid + currency: GBP + totalAmount: 12657.69 + amountDue: 0 + paidOnDate: '2021-04-23T17:30:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-12-08T11:32:00' + payments: + - id: 17b42934-13f6-4738-a506-2e253b1a606f + date: '2021-04-23T17:30:00' + paymentType: payments + amount: 12657.69 + currency: GBP + currencyRate: 1 + - id: aa4503d7-fe01-49fe-ba42-259b421ac640 + invoiceNumber: wdjwiL5B + customerRef: + id: 5cbaf1af-4f02-4206-85ab-c525bd9b4f99 + customerName: Bryana Douglas + issueDate: '2021-04-20T06:46:00' + dueDate: '2021-04-27T06:46:00' + status: PartiallyPaid + currency: GBP + totalAmount: 12935.39 + amountDue: 381.09 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-03-11T20:03:00' + payments: + - id: 1c03986b-9b6c-4220-bde6-4e3eba6cef9f + date: '2021-04-23T14:59:00' + paymentType: payments + amount: 12554.3 + currency: GBP + currencyRate: 1 + - id: d8a0e26e-4ec8-4fb5-887d-8b7531e3bedf + invoiceNumber: cTjJcu8x + customerRef: + id: 6f5290e5-70aa-4d0c-816e-9d2312cf217f + customerName: Brady Wilderman + issueDate: '2021-04-23T09:32:00' + dueDate: '2021-05-03T09:32:00' + status: Paid + currency: GBP + totalAmount: 21526.72 + amountDue: 0 + paidOnDate: '2021-05-03T09:32:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-12T22:37:00' + payments: + - id: 93c9c11b-3ec0-4314-85f6-0751763e752a + date: '2021-05-03T09:32:00' + paymentType: payments + amount: 21506.72 + currency: GBP + currencyRate: 1 + - id: 06890e67-35fb-4276-9857-95db40cfd15d + invoiceNumber: htXJuUDb + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-01T23:23:00' + dueDate: '2021-05-11T23:23:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7151.41 + amountDue: 1225.06 + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2022-02-24T23:02:00' + payments: + - id: 82865077-0857-46db-b9a1-6d21da43b6aa + date: '2021-05-04T17:57:00' + paymentType: payments + amount: 5926.35 + currency: GBP + currencyRate: 1 + - id: 160e8b51-1fa0-46b9-98fe-1ff5399ce99b + invoiceNumber: 9wegEXpG + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-18T08:53:00' + dueDate: '2021-05-25T08:53:00' + status: PartiallyPaid + currency: GBP + totalAmount: 22522.34 + amountDue: 14408.54 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-01-13T07:52:00' + payments: + - id: 75bd7205-bc12-4517-9964-aae159fdfaee + date: '2021-05-23T04:04:00' + paymentType: payments + amount: 8113.8 + currency: GBP + currencyRate: 1 + - id: 5a934955-561d-436a-a564-fd624a79f54c + invoiceNumber: l7YwGxG7 + customerRef: + id: cc96af36-e2f5-49f7-bf40-271503f45071 + customerName: Ignacio Moore + issueDate: '2021-05-25T19:51:00' + dueDate: '2021-06-04T19:51:00' + status: Paid + currency: GBP + totalAmount: 11047.08 + amountDue: 0 + paidOnDate: '2021-05-28T07:31:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-08-06T05:50:00' + payments: + - id: 608fd022-f7d0-44a9-90c4-bebe0573f206 + date: '2021-05-28T07:31:00' + paymentType: payments + amount: 11047.08 + currency: GBP + currencyRate: 1 + - id: 17690788-2936-46b5-ba46-ba6a36a87483 + invoiceNumber: ntH1cRYz + customerRef: + id: e1ecc8f2-8a63-4fe9-97c9-c87fd90ca0a6 + customerName: Freida Ebert + issueDate: '2021-05-27T19:07:00' + dueDate: '2021-06-03T19:07:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7191.32 + amountDue: 5036.83 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-27T08:54:00' + payments: + - id: a343b2a0-d327-41b0-993e-7b6b92fde425 + date: '2021-06-03T19:07:00' + paymentType: payments + amount: 2154.49 + currency: GBP + currencyRate: 1 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets a list of invoices linked to the corresponding banking transaction + '/companies/{companyId}/reports/liabilities/loans/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan transactions report + description: | + The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-transactions + x-speakeasy-name-override: generate-loan-transactions + get: + summary: List loan transactions + description: | + The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. + + This detail gives analysts a better idea of the loan obligations a company may have. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanTransactions' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-loan-transactions + x-speakeasy-name-override: list-loan-transactions + '/companies/{companyId}/reports/liabilities/loans': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan summaries report + description: | + The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-summary + x-speakeasy-name-override: generate-loan-summary + get: + summary: Get loan summaries + description: | + The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. + + The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanSummary' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-loan-summary + x-speakeasy-name-override: get-loan-summary + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get commerce revenue metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: revenue + displayName: Revenue + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Revenue metrics + type: string + items: + - index: 0 + value: Revenue + - index: 1 + value: Revenue growth + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + - displayName: Percentage change vs. previous period + units: '%' + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 0 + itemDisplayName: Revenue + measures: + - index: 0 + measureDisplayName: Value + value: 2392.48 + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 1 + itemDisplayName: Revenue growth + measures: + - index: 1 + measureDisplayName: Percentage change vs. previous period + value: 276.65 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-revenue-metrics + x-speakeasy-name-override: get-revenue + x-speakeasy-group: sales.metrics + description: "The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the revenue metrics.\n\n#### Response structure\n\nThe Revenue report's dimensions and measures are:\n\n| Index | Dimensions |\n|---------------|------------|\n| `index` = 0 | Period |\n| `index` = 1 | Revenue |\n\n| Index | Measures |\n|---------------|--------------------------------------------------------------------------------------------------------------------------|\n| `index` = 0 | Value |\n| `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n" + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get orders report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: orders + displayName: Orders + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Order metrics + type: string + items: + - index: 0 + value: Number of orders + - index: 1 + value: Total value + - index: 2 + value: Average order value + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Order metrics + item: 0 + itemDisplayName: Number of orders + measures: + - index: 0 + measureDisplayName: Count + value: 94 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 1 + itemDisplayName: Total value + measures: + - index: 1 + measureDisplayName: Value + value: 3315.18 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 2 + itemDisplayName: Average order value + measures: + - index: 1 + measureDisplayName: Value + value: 35.27 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-orders-report + x-speakeasy-name-override: get-orders + x-speakeasy-group: sales.reports + description: "The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the order metrics.\n\n#### Response structure\n\nThe Orders report's dimensions and measures are:\n\n| Index | Dimensions |\n|---------------|----------------|\n| `index` = 0 | Period |\n| `index` = 1 | Order metrics |\n\n| Index | Measures |\n|---------------|------------|\n| `index` = 0 | Count |\n| `index` = 1 | Value |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n" + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get refunds report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: refunds + displayName: Refunds + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Refund metrics + type: string + items: + - index: 0 + value: Number of refunds + - index: 1 + value: Value of refunds + - index: 2 + value: Refund rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + - displayName: Percentage + units: '%' + index: 2 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 0 + itemDisplayName: Number of refunds + measures: + - index: 0 + measureDisplayName: Count + value: 39 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 1 + itemDisplayName: Value of refunds + measures: + - index: 1 + measureDisplayName: Value + value: 642.82 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 2 + itemDisplayName: Refund rate + measures: + - index: 2 + measureDisplayName: Percentage + value: 0.41 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-refunds-report + x-speakeasy-name-override: get-refunds + x-speakeasy-group: sales.reports + description: "The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the refunds metrics.\n\n#### Response structure\n\nThe Refunds report's dimensions and measures are:\n\n| Index | Dimensions |\n|----------------|----------------|\n| `index` = 0 | Period |\n| `index` = 1 | Refund metrics |\n\n| Index | Measures |\n|----------------|------------|\n| `index` = 0 | Count |\n| `index` = 1 | Value |\n| `index` = 2 | Percentage |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n" + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get customer retention metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: customer_retention + displayName: Customer Retention + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Customer retention metrics + type: string + items: + - index: 0 + value: Existing customers + - index: 1 + value: New customers + - index: 2 + value: Total customers + - index: 3 + value: Retention rate + - index: 4 + value: Repeat rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Percentage + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 0 + itemDisplayName: Existing customers + measures: + - index: 0 + measureDisplayName: Count + value: 13 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 1 + itemDisplayName: New customers + measures: + - index: 0 + measureDisplayName: Count + value: 47 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 2 + itemDisplayName: Total customers + measures: + - index: 0 + measureDisplayName: Count + value: 60 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 3 + itemDisplayName: Retention rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 0 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 4 + itemDisplayName: Repeat rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 21.67 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-customer-retention-metrics + x-speakeasy-name-override: get-customer-retention + x-speakeasy-group: sales.metrics + description: "The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n#### Customer retention metrics\n\n- __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period. \n- __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period.\n- __Total customers__: the total number of existing and new customers within the specified period.\n- __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage.\n- __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage.\n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate customer retention metrics.\n\n#### Response structure\n\nThe Customer retention report's dimensions and measures are:\n\n| Index | Dimensions |\n|-----------------------------|----------------------------|\n| `index` = 0 | Period |\n| `index` = 1 | Customer retention metrics |\n\n| Index | Measures |\n|----------------------|------------|\n| `index` = 0 | Count |\n| `index` = 1 | Percentage |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination." + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get lifetime value metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: lifetime_value + displayName: Lifetime Value + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Lifetime value metrics + type: string + items: + - index: 0 + value: Lifetime value + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Lifetime value metrics + item: 0 + itemDisplayName: Lifetime value + measures: + - index: 0 + measureDisplayName: Value + value: 3782.07 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-lifetime-value-metrics + x-speakeasy-name-override: get-lifetime-value + x-speakeasy-group: sales.metrics + description: | + The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the lifetime value metrics. + + #### Response structure + + The Lifetime value report's dimensions and measures are: + + | Index | Dimensions | + |---------------|------------------------| + | `index` = 0 | Period | + | `index` = 1 | Lifetime value metrics | + + | Index | Measures | + |-------------------|---------| + | `index` = 1 | Value | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/assess/excel': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Generate Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-excel-report + x-speakeasy-name-override: generate + description: |+ + The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter. + + In response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request. + + ### Report types + + | reportType | Description | + |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| + | `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || [audit](https://docs.codat.io/lending/excel/audit-report) | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. | + | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. | + | `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. | + | `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. | + + [Learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types. + + + parameters: + - $ref: '#/components/parameters/excelReportType' + get: + summary: Get Excel report status + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-excel-report-generation-status + x-speakeasy-name-override: get-status + description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x73\x74\x61\x74\x75\x73\x2A\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x74\x68\x65\x20\x73\x74\x61\x74\x75\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x20\x6D\x6F\x73\x74\x6C\x79\x20\x72\x65\x63\x65\x6E\x74\x6C\x79\x20\x72\x65\x71\x75\x65\x73\x74\x65\x64\x20\x66\x6F\x72\x20\x45\x78\x63\x65\x6C\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x2E\x20\x49\x74\x20\x64\x6F\x65\x73\x20\x6E\x6F\x74\x20\x72\x65\x74\x75\x72\x6E\x20\x74\x68\x65\x20\x73\x74\x61\x74\x75\x73\x20\x6F\x66\x20\x61\x6E\x79\x20\x68\x69\x73\x74\x6F\x72\x69\x63\x61\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x72\x65\x71\x75\x65\x73\x74\x73\x2E\x20\n\n\x50\x6F\x6C\x6C\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x68\x65\x63\x6B\x20\x74\x68\x65\x20\x70\x72\x6F\x67\x72\x65\x73\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x20\x6F\x6E\x63\x65\x20\x79\x6F\x75\x20\x68\x61\x76\x65\x20\x72\x65\x71\x75\x65\x73\x74\x65\x64\x20\x69\x74\x73\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x2E\x20\x54\x68\x69\x73\x20\x77\x69\x6C\x6C\x20\x6E\x6F\x74\x20\x61\x66\x66\x65\x63\x74\x20\x74\x68\x65\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x2E\x20\n\n\x57\x68\x65\x6E\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x20\x63\x6F\x6D\x70\x6C\x65\x74\x65\x73\x20\x73\x75\x63\x63\x65\x73\x73\x66\x75\x6C\x6C\x79\x2C\x20\x74\x68\x65\x20\x60\x69\x6E\x50\x72\x6F\x67\x72\x65\x73\x73\x60\x20\x70\x72\x6F\x70\x65\x72\x74\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x6D\x61\x72\x6B\x65\x64\x20\x61\x73\x20\x60\x66\x61\x6C\x73\x65\x60\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x60\x73\x75\x63\x63\x65\x73\x73\x60\x20\x66\x69\x65\x6C\x64\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x6D\x61\x72\x6B\x65\x64\x20\x61\x73\x20\x60\x74\x72\x75\x65\x60\x2E" + parameters: + - $ref: '#/components/parameters/excelReportType' + '/data/companies/{companyId}/assess/excel/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Download Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: download-excel-report + x-speakeasy-name-override: download + description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x6F\x77\x6E\x6C\x6F\x61\x64\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x64\x6F\x77\x6E\x6C\x6F\x61\x64\x73\x20\x74\x68\x65\x20\x6C\x61\x74\x65\x73\x74\x20\x73\x75\x63\x63\x65\x73\x73\x66\x75\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x64\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x6F\x66\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x72\x65\x70\x6F\x72\x74\x20\x74\x79\x70\x65\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\n\n\x54\x68\x65\x20\x64\x6F\x77\x6E\x6C\x6F\x61\x64\x61\x62\x6C\x65\x20\x45\x78\x63\x65\x6C\x20\x66\x69\x6C\x65\x20\x69\x73\x20\x72\x65\x74\x75\x72\x6E\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x73\x70\x6F\x6E\x73\x65\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x73\x61\x76\x65\x20\x69\x74\x20\x74\x6F\x20\x79\x6F\x75\x72\x20\x6C\x6F\x63\x61\x6C\x20\x6D\x61\x63\x68\x69\x6E\x65\x2E\n\n\x59\x6F\x75\x20\x63\x61\x6E\x20\x5B\x6C\x65\x61\x72\x6E\x20\x6D\x6F\x72\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2F\x66\x65\x61\x74\x75\x72\x65\x73\x2F\x65\x78\x63\x65\x6C\x2D\x64\x6F\x77\x6E\x6C\x6F\x61\x64\x2D\x6F\x76\x65\x72\x76\x69\x65\x77\x23\x66\x65\x61\x74\x75\x72\x65\x2D\x63\x6F\x6D\x70\x6F\x6E\x65\x6E\x74\x73\x29\x20\x61\x62\x6F\x75\x74\x20\x76\x61\x6C\x69\x64\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x74\x79\x70\x65\x73\x2E" + parameters: + - $ref: '#/components/parameters/excelReportType' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions': + get: + tags: + - Transactions + summary: List account transactions + description: "The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection.\n\n[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-account-transactions + x-speakeasy-group: transactions.account-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransactions' + examples: + Clear Books: + value: + results: + - id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: f2656119-9521-4d51-a24d-003b44c1410b + transactionId: 1fde4f8f-68ca-48fc-8fe7-79ac467d2946 + note: Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Void + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + amount: 32095.91 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1745 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + transactionId: DFA-933785132 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-05T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: DFA-933785132 + dataType: directCosts + amount: -35 + totalAmount: -35 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 652 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: '5' + transactionId: '5' + bankAccountRef: + id: '81' + name: Current + date: '2015-11-24T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: contribution to start business + recordRef: + id: 5-1 + dataType: directIncomes + amount: 10000 + - description: funds borrowed to start business + recordRef: + id: 5-2 + dataType: directIncomes + amount: 25000 + totalAmount: 35000 + modifiedDate: '2023-04-26T09:37:17' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + transactionId: '15' + note: Payment to Google + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Payment to Google + recordRef: + id: PUR-15 + dataType: directCosts + amount: -1.59 + totalAmount: -1.59 + modifiedDate: '2023-01-18T11:03:11' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5984 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2 + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + transactionId: 65b746c8-9a5d-4a95-8096-d2316fcff592 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2022-02-17T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + dataType: payments + amount: 4200 + totalAmount: 4200 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}': + get: + tags: + - Transactions + summary: Get account transaction + operationId: get-accounting-account-transaction + x-speakeasy-group: transactions.account-transactions + description: | + The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. + + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: accountTransactionId + in: path + required: true + schema: + type: string + description: Unique identifier for an account transaction. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransaction' + examples: + Clear Books: + value: + id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts': + get: + tags: + - Financial statements + summary: List accounts + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x5B\x61\x63\x63\x6F\x75\x6E\x74\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x41\x63\x63\x6F\x75\x6E\x74\x29\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2E\n\n\x5B\x41\x63\x63\x6F\x75\x6E\x74\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x41\x63\x63\x6F\x75\x6E\x74\x29\x20\x61\x72\x65\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x75\x73\x65\x73\x20\x74\x6F\x20\x72\x65\x63\x6F\x72\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2E\n\n\x42\x65\x66\x6F\x72\x65\x20\x75\x73\x69\x6E\x67\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x2C\x20\x79\x6F\x75\x20\x6D\x75\x73\x74\x20\x68\x61\x76\x65\x20\x5B\x72\x65\x74\x72\x69\x65\x76\x65\x64\x20\x64\x61\x74\x61\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x72\x65\x66\x72\x65\x73\x68\x2D\x63\x6F\x6D\x70\x61\x6E\x79\x2D\x64\x61\x74\x61\x29\x2E" + operationId: list-accounting-accounts + x-speakeasy-group: financial-statements.accounts + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/AccountingAccounts' + examples: + Clear Books: + value: + results: + - id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 76d5f23b-9623-4e3b-89cd-da57228764d3 + nominalCode: '611' + name: Accounts Receivable + description: A provision anticipating that a portion of accounts receivable will never be collected. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-10-19T05:49:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 98 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: c0861a65-c69f-ec11-80f1-0022481b4546 + nominalCode: '10' + name: Account no cat Balance Sheet + fullyQualifiedCategory: ' .' + fullyQualifiedName: ..Account no cat Balance Sheet + currency: GBP + currentBalance: 27.34 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-09-13T14:45:01Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 122 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: 2052b65b-20e9-4da1-85d8-fd5ca0ea3d38 + nominalCode: '888777888' + name: One more AR account + description: One more AR account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled + currency: EUR + currentBalance: 2174.82 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2021-06-10T11:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 230 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: cf9572e7-8afa-4339-9113-af32a66d9df9 + nominalCode: '15400' + name: Trade Debtors + description: Trade Debtors + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled + currency: GBP + currentBalance: 4484655.39 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2020-01-08T13:48:38Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 121 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '605' + nominalCode: '605' + name: Capital Asset Depreciation Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Depreciation Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 292 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '128611' + nominalCode: 1200-1 + name: Accounts Receivable + fullyQualifiedCategory: Asset.Accounts Receivable + fullyQualifiedName: Asset.Accounts Receivable.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 96 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + - id: '27840049' + nominalCode: '70600' + name: 1a1a + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.1a1a + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 157 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + - id: '119' + name: Accounts Receivable + fullyQualifiedCategory: AcctRec.AcctRec + fullyQualifiedName: AcctRec.AcctRec.Accounts Receivable + currentBalance: -565 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-09-08T15:23:31' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 20000-933270541 + nominalCode: '10100' + name: Checking + description: Cash + fullyQualifiedCategory: Asset.CurrentAsset.Bank + fullyQualifiedName: Asset.CurrentAsset.Bank.Checking + currency: GBP + currentBalance: 46954.1 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: + - property: Id + links: + - BillLineItem.AccountRef.Id + - BillPayment.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 116 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + - id: '92' + nominalCode: '247' + name: Debtors - AED + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - AED + currency: AED + currentBalance: -1533.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2021-02-19T14:04:45Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 234 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '80' + name: Debtors - USD + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - USD + currency: USD + currentBalance: 54822.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-12T15:10:38Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 186 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + metadata: + isDeleted: true + - id: '2368' + nominalCode: '1200' + name: Bank Current Account + description: Bank Current Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Current Account + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-09-11T13:53:12Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 344 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '1102' + nominalCode: '1102' + name: Other Debtors + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Other Debtors + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 155 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: b17083bc9b2748b4ab321b024e260eda + nominalCode: '147852' + name: Abdi Live Test + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Live Test + currency: GBP + currentBalance: 225830.75 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 283 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '155' + nominalCode: '12710' + name: AR - Retainage + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.AR - Retainage' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-10-15T15:33:15' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 181 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=2&pageSize=2 + Wave: + value: + results: + - id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + - id: QWNjb3VudDo3OTE3NTA1OTcwOTQxNzQ3MTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Cash on Hand + description: Cash you haven�t deposited in the bank. Add your bank and credit card accounts to accurately categorize transactions that aren't cash. + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Cash on Hand + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 85 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + nominalCode: A091 + name: Business Savings Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Savings Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + - id: '104957000000060010' + nominalCode: '' + name: Abdi Test + description: '' + fullyQualifiedCategory: Asset.bank + fullyQualifiedName: Asset.bank.Abdi Test + currency: GBP + currentBalance: 69858.44 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-17T12:19:47' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 68 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Financial statements + summary: Get account + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount' + examples: + Clear Books: + value: + id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + Dynamics 365 Business Central: + value: + id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + Exact (Netherlands): + value: + id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Exact (UK): + value: + id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + FreeAgent: + value: + id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + FreshBooks: + value: + id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + KashFlow: + value: + id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + Oracle NetSuite: + value: + id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + QuickBooks Desktop: + value: + id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + QuickBooks Online: + value: + id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + QuickBooks Online Sandbox: + value: + id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + Sage 200cloud: + value: + id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + Sage 50 (UK): + value: + id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + Sage Business Cloud Accounting: + value: + id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Sage Intacct: + value: + id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + Wave: + value: + id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + Zoho Books: + value: + id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-account + x-speakeasy-group: financial-statements.accounts + '/companies/{companyId}/data/billCreditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + - id: 157c025f-a19e-eb11-8ce6-0022481a7bed + billCreditNoteNumber: '109002' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 20 + totalDiscount: 0 + subTotal: 20 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 257c025f-a19e-eb11-8ce6-0022481a7bed + note: Credit Memo 1002 + reference: '109002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-04-16T00:00:00' + totalAmount: 10 + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: '16042021' + pageNumber: 1 + pageSize: 2 + totalResults: 224 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + - id: 6643f559-d7e9-4cfe-802f-60beddbc4ed9 + billCreditNoteNumber: '20600003' + supplierRef: + id: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + withholdingTax: [] + totalAmount: 13.57 + totalDiscount: 0 + subTotal: 13.57 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 13.57 + status: Submitted + issueDate: '2020-01-20T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + unitAmount: 13.57 + quantity: 1 + discountAmount: 0 + subTotal: 13.57 + totalAmount: 13.57 + accountRef: + id: f6c251f5-21d0-4164-9b8f-17789fd2fee9 + name: Kosten werkgeverslasten vakantiegeld + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-20T19:38:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + - id: 05023688-5bd5-4034-ae4c-5e3e5099bbfb + billCreditNoteNumber: '19600009' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2019-11-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Credit note line item #5' + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + totalAmount: 10 + accountRef: + id: 62be6536-f4ea-49b8-9797-1adc23982334 + name: Depreciation + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-11-01T15:07:18Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + - id: '11007024' + billCreditNoteNumber: Draft test + supplierRef: + id: '6161963' + supplierName: ABB Ltd + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 8.33 + totalTaxAmount: 1.67 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2018-10-17T00:00:00' + currency: GBP + lineItems: + - description: ABB Ltd - Bill Credit Note Draft test + unitAmount: 8.33 + quantity: 1 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-10-17T12:56:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + - id: '91341939' + billCreditNoteNumber: '6' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 240 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: -200 + quantity: -1 + subTotal: 200 + taxAmount: -40 + totalAmount: 240 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '114821376' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + - id: '1782' + billCreditNoteNumber: VENDCRED2 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 642.3 + totalDiscount: 0 + subTotal: 535.25 + totalTaxAmount: 107.05 + discountPercentage: 0 + remainingCredit: 342.3 + status: PartiallyPaid + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Cheese + unitAmount: 400 + quantity: 1 + unitOfMeasurement: pack + subTotal: 400 + totalAmount: 400 + accountRef: + id: '714' + name: Cost of Goods Sold + createdFromLineRef: + id: '7462' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: double cream + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '714' + name: Cost of Goods Sold + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: '' + unitAmount: 35.25 + quantity: 1 + subTotal: 35.25 + totalAmount: 35.25 + accountRef: + id: '54' + name: Sales + itemRef: + id: '128' + name: Test Item + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: '1782' + note: Codat1 + reference: Bill Credit 02/11/2021 + currency: GBP + currencyRate: 1 + paidOnDate: '2021-11-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + createdFromRefs: + - id: '7462' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-03T18:27:14' + note: Codat1 + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + - id: F3A-933787869 + billCreditNoteNumber: CR-1098 + supplierRef: + id: 80000-933272656 + supplierName: Sloan Roofing + withholdingTax: [] + totalAmount: 850 + totalDiscount: 0 + subTotal: 850 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 850 + status: Submitted + issueDate: '2024-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Subs:Roofing - Roofing' + unitAmount: 850 + quantity: 0 + discountAmount: 0 + subTotal: 850 + taxAmount: 0 + totalAmount: 850 + discountPercentage: 0 + itemRef: + id: D0000-933272656 + name: 'Subs:Roofing' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: F3A-933787869 + reference: CR-1098 + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 850 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:05:03' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + - id: '677' + billCreditNoteNumber: '677' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-03-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + note: Codat Note field + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + - id: '455' + billCreditNoteNumber: '455' + supplierRef: + id: '53' + supplierName: Bank of AnyCity + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-06-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: a + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '11' + name: Ask My Accountant + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '530' + reference: '4' + accountRef: + id: '100' + name: Savings2 + currency: GBP + currencyRate: 1 + paidOnDate: '2019-07-16T00:00:00' + totalAmount: 170 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-07-16T09:49:14Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + - id: '45421' + billCreditNoteNumber: Return 2 + supplierRef: + id: QUA001 + supplierName: Quality Motors + withholdingTax: [] + totalAmount: 60 + totalDiscount: 1.25 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 2.5 + remainingCredit: 60 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-02-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.25 + subTotal: 0 + taxAmount: 10 + totalAmount: 10 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.25 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + - id: '323' + billCreditNoteNumber: Return + supplierRef: + id: UNI001 + supplierName: Unique Systems + withholdingTax: [] + totalAmount: 103.4 + totalDiscount: 0 + subTotal: 88 + totalTaxAmount: 15.4 + discountPercentage: 0 + remainingCredit: 103.4 + status: Submitted + issueDate: '2022-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Returned Goods, damaged' + unitAmount: 103.4 + quantity: 1 + subTotal: 88 + taxAmount: 15.4 + totalAmount: 103.4 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: 'Returned Goods, damaged' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + - id: 23d866f6367d4f11956a36a71e47bc37 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + withholdingTax: [] + totalAmount: 60 + totalDiscount: 0 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 0 + remainingCredit: 60 + status: Submitted + issueDate: '2019-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 5 + discountAmount: 0 + subTotal: 50 + taxAmount: 10 + totalAmount: 60 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2020-07-16T15:00:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 747 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + - id: '3399' + billCreditNoteNumber: APADJ0002 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 360 + totalDiscount: 0 + subTotal: 300 + totalTaxAmount: 60 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-09-24T00:00:00' + allocatedOnDate: '2021-09-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 300 + quantity: 1 + subTotal: 300 + taxAmount: 60 + totalAmount: 360 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '81' + name: UK Purchase Goods Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-29T13:34:47' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=2&pageSize=2 + Xero: + value: + results: + - id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + - id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + billCreditNoteNumber: 720-2 + supplierRef: + id: cf8fa320-a527-496c-823e-22dd069d29e6 + supplierName: PC Complete + withholdingTax: [] + totalAmount: 270.36 + totalDiscount: 0 + subTotal: 270.36 + totalTaxAmount: 45.06 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-16T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Unable to supply DVD writer for laptop + unitAmount: 225.3 + quantity: 1 + discountAmount: 0 + subTotal: 225.3 + taxAmount: 45.06 + totalAmount: 270.36 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-16T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-16T00:00:00' + totalAmount: 270.36 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-06T21:00:33' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-bill-credit-notes + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: billCreditNoteId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill credit note. + get: + tags: + - Accounts payable + summary: Get bill credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + Exact (Netherlands): + value: + id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + Exact (UK): + value: + id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + FreeAgent: + value: + id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + createdFromLineRef: + id: '1432' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + createdFromRefs: + - id: '1432' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + QuickBooks Desktop: + value: + id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + QuickBooks Online Sandbox: + value: + id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + Sage 50 (UK): + value: + id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + Sage Business Cloud Accounting: + value: + id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + Sage Intacct: + value: + id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + Xero: + value: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. + + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-credit-note + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billPayments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayments' + examples: + Clear Books: + value: + results: + - id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + - id: ca0976d0-036d-4187-ab66-7169286b007d + supplierRef: + id: 9efd64dc-4b31-425d-9eb2-7c7773593713 + supplierName: 'Jacobson, Konopelski and Heidenreich' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 16221.64 + currency: GBP + currencyRate: 1 + date: '2022-05-14T13:12:00' + note: Bill Payment against bill 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + paymentMethodRef: + id: fc87fba8-812e-4a54-b633-29ef2abf4c12 + name: CreditCard payments-u4p + lines: + - amount: 16221.64 + links: + - type: Bill + id: 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + amount: -16221.64 + currencyRate: 1 + allocatedOnDate: '2022-05-14T13:12:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-14T13:12:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 232 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + - id: 3d387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 390 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107007 + lines: + - amount: 390 + links: + - type: Bill + id: cbcb06bf-89d1-ea11-bbaa-000d3a2b9185-108007 + amount: -390 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108007' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 236 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + - id: 002b8462-f3a3-4019-84fe-6a2af1f30c5a + supplierRef: + id: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + accountRef: + id: 1879b322-7758-4e20-8f3f-701df27f2340 + name: Kas + totalAmount: 0.13 + currency: EUR + currencyRate: 1 + date: '2019-11-07T00:00:00Z' + lines: + - amount: -0.12 + links: + - type: CreditNote + id: 33f3016c-2ecf-4d17-911e-b385537e7341 + amount: 0.12 + currencyRate: 1 + - amount: 0.12 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.12 + currencyRate: 1 + - amount: 0.13 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.13 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2021-11-17T12:08:10Z' + reference: '19100002' + pageNumber: 1 + pageSize: 2 + totalResults: 1173 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + - id: b358df76-3930-42ad-8f38-78edcc60172d + supplierRef: + id: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 55000 + currency: GBP + currencyRate: 1 + date: '2017-10-31T00:00:00Z' + lines: + - amount: 55000 + links: + - type: PaymentOnAccount + id: 41302634-76b5-4442-b800-0bb63780e77c + amount: -55000 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2019-02-14T17:56:54Z' + reference: '17200001' + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + - id: '168350314' + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + totalAmount: 30 + currency: GBP + date: '2019-01-03T00:00:00' + note: �30.00 - Bill payment against Test123 (A & J Fabtech Ltd) + lines: + - amount: 30 + links: + - type: Bill + id: '11224800' + amount: -30 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 89 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + - id: '18' + supplierRef: + id: '39' + accountRef: + id: '167679' + name: Cash + totalAmount: 15 + currency: USD + date: '2021-08-18T00:00:00' + note: Bill payment Ikea + lines: + - amount: 15 + links: + - type: Bill + id: '18' + amount: -15 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + - id: 159623-724 + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: -555.55 + currency: GBP + currencyRate: 1 + date: '2022-07-11T00:00:00' + lines: + - amount: -555.55 + links: + - type: PaymentOnAccount + id: '724' + amount: 555.55 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2022-07-11T09:41:02' + reference: 'Deposit #DEP25' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + - id: 84C2-1197705262 + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + accountRef: + id: '8000007E-1197732180' + name: CalOil Credit Card + totalAmount: 4050.98 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + lines: + - amount: 4050.98 + links: + - type: Bill + id: 84C2-1197705262 + amount: -4050.98 + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:06:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 214 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + - id: '25' + supplierRef: + id: '5' + supplierName: Callum McGinley + accountRef: + id: '63' + name: Business Bank Account + totalAmount: 5999.99 + currency: GBP + currencyRate: 1 + date: '2019-05-31T00:00:00' + lines: + - amount: 5999.99 + links: + - type: Bill + id: '24' + amount: -5999.99 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-31T12:55:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 126 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + - id: '159' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 742.5 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 742.5 + links: + - type: Bill + id: '28' + amount: -742.5 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + reference: '1068' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 191 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + - id: '45502' + supplierRef: + id: SDE001 + supplierName: S D Enterprises + totalAmount: 59 + currency: GBP + currencyRate: 1 + date: '2020-01-17T00:00:00Z' + note: pay3 + lines: + - amount: 59 + links: + - type: PaymentOnAccount + id: SDE001 + amount: -59 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: payment inv3 + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '256' + supplierRef: + id: QUA001 + supplierName: Quality Motors + totalAmount: 256.36 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 256 linked to, purchase invoice 17.' + lines: + - amount: 256.36 + links: + - type: Bill + id: '17' + amount: -256.36 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 27 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + - id: a99b9aae216111e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a3e4bc6267a11e797950a57719b2edb + name: Cash + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-03-06T00:00:00' + note: Supplier payment using cash + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2018-03-06T17:13:17Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2225 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + - id: '4472' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 5 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 5 + links: + - type: Bill + id: '4470' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:06:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection.\n\n[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-bill-payments + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/billPayments/{billPaymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillPaymentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayment' + examples: + Clear Books: + value: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + Exact (UK): + value: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + FreeAgent: + value: + id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + QuickBooks Desktop: + value: + id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + QuickBooks Online Sandbox: + value: + id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + Sage 50 (UK): + value: + id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + Sage Intacct: + value: + id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill payment + description: | + The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. + + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-payment + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/bills': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bills + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBills' + examples: + Clear Books: + value: + results: + - id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + - id: acc1dc9d-a21a-41b8-953e-73da4afab6e6 + reference: d88e83b8-a5cc-4578-815d-afa263df4beb + supplierRef: + id: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + purchaseOrderRefs: + - id: 7f07b584-bebe-450f-aa9e-1d7aed630b66 + purchaseOrderNumber: ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + issueDate: '2022-04-30T00:00:00' + dueDate: '2022-05-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 4 + discountAmount: 0 + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-04-14T01:56:02' + note: Bill for purchase order ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + paymentAllocations: + - payment: + id: a4fa017a-3911-4eb0-aaf9-b002c446c8c3 + note: Bill Payment against bill acc1dc9d-a21a-41b8-953e-73da4afab6e6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-15T00:00:00' + totalAmount: 418.35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-15T00:00:00' + totalAmount: -418.35 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 183 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + - id: b9cb06bf-89d1-ea11-bbaa-000d3a2b9185-108001 + reference: '108001' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 0 + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + discountPercentage: 0 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + amountDue: 0 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:02Z' + note: '107001' + paymentAllocations: + - payment: + id: 57377f05-8ad1-ea11-bbaa-000d3a2b9185 + note: Invoice 107001 + reference: '108001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-01T00:00:00' + totalAmount: 2431.68 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + totalAmount: -2431.68 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 294 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - id: ec0c61a1-deb6-4496-b9ee-feb29b16019c + reference: '19600008' + supplierRef: + id: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 12.1 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:39Z' + paymentAllocations: + - payment: + id: ef5d140b-16da-4fd2-a0c8-d5bfb89a13ee + reference: '19900056' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: b69e7ad4-2b90-4a5f-a8a0-67418ac95531 + reference: '19900053' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.2 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.2 + - payment: + id: 6ccd1256-6073-4bfc-8d88-700417685e72 + reference: '21200028' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-10-05T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - payment: + id: 69a8533b-3e59-4d2d-9bca-bc37bc0f7984 + reference: '19900055' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: 2dae3548-ff11-4ad8-886c-eb5cb7965024 + reference: '19900054' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + pageNumber: 1 + pageSize: 2 + totalResults: 80 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + - id: 064fbab9-9b4d-4e83-b2df-0f4ce12bc2bf + reference: '19600001' + supplierRef: + id: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + purchaseOrderRefs: [] + issueDate: '2019-01-11T00:00:00Z' + dueDate: '2019-02-10T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Basket balls + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '23' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T12:03:31Z' + paymentAllocations: + - payment: + id: d871f677-c2df-4069-bda0-c6804a46b71b + reference: '19200001' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2019-02-10T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '16609589' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:50:41Z' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 137 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '29' + supplierRef: + id: '89' + purchaseOrderRefs: [] + issueDate: '2021-04-28T00:00:00' + dueDate: '2021-05-28T00:00:00' + currency: GBP + lineItems: + - description: Advertising refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-08-18T13:52:33' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + - id: '76144089' + reference: '1' + supplierRef: + id: '6202387' + supplierName: Dell + purchaseOrderRefs: [] + issueDate: '2019-01-28T00:00:00' + dueDate: '2019-02-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 120 + quantity: 5 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '95293985' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + - id: '165372' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2022-07-15T00:00:00' + dueDate: '2022-07-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 555.78 + quantity: 1 + subTotal: 555.78 + totalAmount: 555.78 + accountRef: + id: '844' + name: Asset account test 2 + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 555.78 + taxAmount: 0 + totalAmount: 555.78 + amountDue: 500 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-15T11:35:47' + paymentAllocations: + - payment: + id: '165373' + reference: 'Bill Payment #2' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2022-07-15T00:00:00' + totalAmount: 555.78 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -55.78 + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "Cabinets:Light Pine - Light pine kitchen cabinet wall unit \n#CLD- 1235-p" + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + metadata: + isDeleted: false + - id: 5CAB-1197713763 + reference: '8374892' + supplierRef: + id: 30000-933272656 + supplierName: C. U. Electric + purchaseOrderRefs: [] + issueDate: '2022-12-15T00:00:00' + dueDate: '2024-01-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 532 + quantity: 1 + discountAmount: 0 + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + discountPercentage: 0 + accountRef: + id: 490000-933270542 + name: Gas and Electric + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + categoryRefs: + - id: 80000007-1197713802 + name: Overhead + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E42-1182131999 + reference: '113' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 532 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -532 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: '22' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + pageNumber: 1 + pageSize: 2 + totalResults: 147 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + - id: '28' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-06T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: promotional items -- misc engraved items + unitAmount: 8.25 + quantity: 75 + discountAmount: 0 + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '59' + companyName: Ecker Holiday event + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + paymentAllocations: + - payment: + id: '159' + reference: '1068' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 742.5 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -742.5 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 711 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + - id: '45131' + reference: Order 2 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-03-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 31.6 + totalAmount: 31.6 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 158 + taxAmount: 0 + totalAmount: 158 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 158 + taxAmount: 31.6 + totalAmount: 189.6 + amountDue: 179.1 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No2 + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10.5 + pageNumber: 1 + pageSize: 2 + totalResults: 162 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + - id: '93' + reference: '2570' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-15T00:00:00' + dueDate: '2022-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 1175 + quantity: 1 + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1175 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 95 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: 09034445789211e8aaa5027d54329956 + reference: '25/06/2018 - 1,000.00' + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + purchaseOrderRefs: [] + issueDate: '2018-06-25T00:00:00' + dueDate: '2018-07-25T00:00:00' + currency: USD + currencyRate: 0.752601305 + lineItems: + - description: Bagels + unitAmount: 1000 + quantity: 1 + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + amountDue: 0 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2022-02-22T13:48:56Z' + paymentAllocations: + - payment: + id: 66d010243e3441ba89a793446eb9c74b + note: Supplier payment using credit/debit card - Test note + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.734679838 + paidOnDate: '2022-02-16T00:00:00' + totalAmount: 1000 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -1000 + pageNumber: 1 + pageSize: 2 + totalResults: 4658 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + metadata: + isDeleted: false + - id: '4705' + reference: JohnAndRob + supplierRef: + id: '8' + supplierName: Worldwide Commercial + purchaseOrderRefs: [] + issueDate: '2022-02-04T00:00:00' + dueDate: '2022-02-19T00:00:00' + currency: USD + currencyRate: 14 + lineItems: + - description: Some text for a description + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '49' + name: EC Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 10 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-22T12:24:59' + note: Some note on my bill + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=2&pageSize=2 + Xero: + value: + results: + - id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + - id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2022-01-17T00:00:00' + dueDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:06:22' + paymentAllocations: + - payment: + id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + - id: '104957000000152067' + reference: '2' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 12 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-11-04T13:07:23' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: list-accounting-bills + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/bills/{billId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBill' + examples: + Clear Books: + value: + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + Exact (UK): + value: + id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + FreeAgent: + value: + id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + FreshBooks: + value: + id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + KashFlow: + value: + id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + Oracle NetSuite: + value: + id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + QuickBooks Desktop: + value: + id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "Cabinets:Light Pine - Light pine kitchen cabinet wall unit \n#CLD- 1235-p" + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + QuickBooks Online Sandbox: + value: + id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + Sage 50 (UK): + value: + id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + Sage Intacct: + value: + id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + metadata: + isDeleted: false + Xero: + value: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill + description: | + The *Get bill* endpoint returns a single bill for a given billId. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: get-accounting-bill + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-accounting-bill-attachments + x-speakeasy-group: accounts-payable.bills + summary: List bill attachments + description: | + The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill attachment + description: |- + The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: get-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download bill attachment + description: |- + The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: download-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/creditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + - id: d0d9b378-1d60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104002' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 779.28 + totalDiscount: 0 + subTotal: 649.4 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 129.88 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: 'Inv. No. 103222 - Shpt. No. 102222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: ATHENS Desk -pay with CR + unitAmount: 649.4 + quantity: 1 + discountAmount: 0 + subTotal: 649.4 + taxAmount: 129.88 + totalAmount: 779.28 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: c2942210-1e60-eb11-89fa-00224800a9c7 + note: Credit Memo 1002 + reference: 'Document No: 104002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-26T00:00:00' + totalAmount: 779.28 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:33:01Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + - id: '53604300' + creditNoteNumber: '2367' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 165 + status: Draft + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2022-09-29T13:00:09Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 281 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + - id: '33409' + creditNoteNumber: '0000066' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 300 + totalDiscount: 0 + subTotal: 300 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Draft + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 2 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054021' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '85326016' + creditNoteNumber: '5' + customerRef: + id: '69952389' + companyName: Things Limited + withholdingTax: [] + totalAmount: 1000 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '158675173' + unitAmount: 1 + quantity: -1000 + subTotal: -1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158675173' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86873915' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 400 + - payment: + id: '86874181' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + - payment: + id: '86874199' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -50 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 50 + - payment: + id: '86875655' + note: Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -750 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 750 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + - id: '8828' + creditNoteNumber: CM28 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '8828' + reference: 'Credit Memo #CM28' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-09T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 16 + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:37' + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes + QuickBooks Online: + value: + results: + - id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + - id: '86' + creditNoteNumber: '3122019_66' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 1 + totalDiscount: 0 + subTotal: 1 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Card + unitAmount: 1 + quantity: 1 + subTotal: 1 + taxAmount: 0 + totalAmount: 1 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '86' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -1 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 1 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1253 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + - id: '213' + creditNoteNumber: '1030' + customerRef: + id: '5' + companyName: Whitehead and Sons + withholdingTax: [] + totalAmount: 600 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 100 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-12-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee celebration -- Anniversary / Retirement + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 100 + totalAmount: 600 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '4' + name: Employee Celebration + trackingCategoryRefs: + - id: DEPARTMENT_3 + name: Birmingham + isDirectIncome: false + paymentAllocations: + - payment: + id: '215' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2018-12-18T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 600 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2018-12-18T10:08:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + - id: '45901' + creditNoteNumber: return 003 + customerRef: + id: ABS001 + companyName: ABS Garages Ltd + withholdingTax: [] + totalAmount: 177.14 + totalDiscount: 4.42 + subTotal: 147.62 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 29.52 + discountPercentage: 2.5 + remainingCredit: 177.14 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.73 + subTotal: 0 + taxAmount: 29.52 + totalAmount: 29.52 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 4.42 + subTotal: 147.62 + taxAmount: 0 + totalAmount: 147.62 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: cred 003 + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + - id: INV-34 + creditNoteNumber: '34' + customerRef: + id: MIL001 + companyName: Mile Road Health Centre + withholdingTax: [] + totalAmount: 1668.14 + totalDiscount: 0 + subTotal: 1425 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 243.14 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 6 + unitAmount: 1668.14 + quantity: 1 + subTotal: 1425 + taxAmount: 243.14 + totalAmount: 1668.14 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '530' + note: Sales credit inv-34 linked to sales invoice inv-26. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-28T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1668.14 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 6 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + - id: 28a459069a6211e8bad90617b3da4b8a + creditNoteNumber: SCN-3 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 5400 + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-08-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 28a459069a6211e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5400 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2018-08-07T16:51:41Z' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 2972 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + - id: '5020' + creditNoteNumber: ARADJ0034 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 115 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 15 + discountPercentage: 0 + remainingCredit: 115 + status: Submitted + issueDate: '2022-03-16T00:00:00' + currency: ZAR + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 15 + totalAmount: 115 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '28' + name: Standard Rate (Capital Goods) Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:30:19' + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes + Xero: + value: + results: + - id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + - id: caba470e-962f-4168-9c57-35caa289204d + creditNoteNumber: CN-0026 + customerRef: + id: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + companyName: Boom FM + withholdingTax: [] + totalAmount: 500 + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2023-01-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "CREDIT Half day training - Microsoft Office and include in suite of training\r\nINV-0024" + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: + - id: b3900cc6-3745-40ea-955f-9ef7b1c8cf7e + name: South + isDirectIncome: false + paymentAllocations: + - payment: + id: caba470e-962f-4168-9c57-35caa289204d + reference: Training + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-13T00:00:00' + totalAmount: 500 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T02:47:04' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + - id: '104957000000134023' + creditNoteNumber: CN-00002 + customerRef: + id: '104957000000054050' + companyName: 'Doe, John' + withholdingTax: [] + totalAmount: 125 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-05-06T13:04:20' + currency: GBP + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000134039' + currency: GBP + paidOnDate: '2020-05-06T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 125 + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-05-06T13:05:27' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection.\n\n[Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-credit-notes + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/creditNotes/{creditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: creditNoteId + in: path + required: true + schema: + type: string + description: Unique identifier for a credit note. + get: + tags: + - Accounts receivable + summary: Get credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + KashFlow: + value: + id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + QuickBooks Desktop: + value: + id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + QuickBooks Online Sandbox: + value: + id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + Sage 50 (UK): + value: + id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + Sage Intacct: + value: + id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + - id: LOCATION-10 + name: South Africa + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + Xero: + value: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get credit note* endpoint returns a single credit note for a given creditNoteId. + + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-credit-note + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/customers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List customers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomers' + examples: + Clear Books: + value: + results: + - id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + contactName: Miguel Hahn + emailAddress: contact@BreitenbergEmardandSchiller.biz + defaultCurrency: GBP + phone: 0800 445 6957 + addresses: + - type: Billing + line1: Apt. 184 + line2: 60578 Louie Springs + city: East Khalid + region: Wales + country: United Kingdom + postalCode: XW89 7NT + contacts: + - name: Miguel Hahn + email: Miguel.Hahn@gmail.com + phone: + - number: 018555 09614 + type: Landline + address: + type: Delivery + line1: Suite 400 + line2: 21930 Milan Lane + city: Reingerton + region: Wales + country: United Kingdom + postalCode: QG10 2DL + status: Active + registrationNumber: KME0AMIL + taxNumber: '8560920952.553111' + status: Archived + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-12-03T11:05:01' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-06-03T08:48:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 + customerName: anna test 2 + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-05-24T11:53:21Z' + pageNumber: 1 + pageSize: 2 + totalResults: 71 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c + customerName: Abdulbasit Al-haj + contactName: abeee + emailAddress: a.alhaj@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + country: GB + contacts: + - name: abeee + phone: [] + address: + type: Unknown + line1: '' + country: 'GB ' + status: Active + modifiedDate: '2020-02-24T12:00:51.027Z' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-24T12:00:50Z' + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + - id: '9677150' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-24T06:19:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: 1234 56789 + type: Primary + - number: 9876 54321 + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + - id: '634486' + customerName: A test customer name 2 + contactName: test person name + emailAddress: test8@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test9@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test10@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test8@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-11T11:39:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: '88459410' + customerName: Diogo Sousa + contactName: Mr Diogo Sousa + emailAddress: diogomail@mail.com + phone: '123123123' + addresses: + - type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + - type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + contacts: + - name: Mr Diogo Sousa + email: diogomail@mail.com + phone: + - number: '123123123' + type: Landline + - number: '321321321' + type: Mobile + address: + type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + status: Active + - name: Mr Diogo Sousa + phone: [] + address: + type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2021-05-04T13:22:19' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + - id: '172722' + customerName: 1248 European Company + contactName: European Company + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-07-27T14:29:16' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + - id: 800000D0-1182061376 + customerName: 'Allard, Robert' + contactName: Amanda Roberts + emailAddress: rallard@myemail.com + defaultCurrency: GBP + phone: 650-555-3422 + addresses: + - type: Delivery + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + - type: Billing + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + contacts: + - name: 'Allard, Robert' + email: rallard@myemail.com + 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 + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + - id: '49' + customerName: adeel qbo child test + contactName: Adeel test + emailAddress: adeel@adeel.com + defaultCurrency: GBP + phone: '123456789' + addresses: + - type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + - type: Delivery + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + contacts: + - name: Adeel test + email: adeel@adeel.com + phone: + - number: '123456789' + type: Primary + - number: '07546543216' + type: Mobile + address: + type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + status: Active + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-08-22T09:21:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + - id: '67' + customerName: Abercrombie International Group + contactName: Natalie Watts + emailAddress: n.watts@google.com + defaultCurrency: USD + addresses: + - type: Billing + - type: Delivery + contacts: + - name: Abercrombie International Group + email: n.watts@google.com + phone: [] + address: + type: Billing + status: Active + registrationNumber: XXXXVat123456 + taxNumber: XXXXVat123456 + status: Active + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2023-03-29T01:12:55Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 243 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + - id: A1D002 + customerName: A2 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Billing + line1: 77a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 40 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2020-09-23T10:28:58Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + - id: ABS001 + customerName: ABS Garages Ltd + contactName: Mike Hall + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 0191 254 5909 + addresses: + - type: Delivery + line1: Swanson Industries + line2: Dukes Industrial Estate + city: Whitley Bay + region: North Tyneside + country: GB + postalCode: NE56 4ER + - type: Delivery + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + - type: Unknown + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + contacts: [] + taxNumber: GB745 4584 68 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + - id: 44a5d9461d9e4f6d90a5ace251c5cf35 + customerName: 100 test name DS + contactName: Main Contact + emailAddress: DCemail@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: POST - Aruba Address line 1 + line2: POST - Aruba Address line 2 + city: POST - Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: [] + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-06-10T14:22:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 168 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + - id: '324' + customerName: 3Way International Logistics + contactName: Lauri O'Heagertie + defaultCurrency: CAD + phone: 410-309-3976 + addresses: + - type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + contacts: + - name: 'O''Heagertie, Lauri' + phone: + - number: 410-309-3976 + type: Primary + address: + type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2020-10-20T05:01:49' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 530 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 + customerName: Coffee Cart + contactName: Coffee Carl + emailAddress: coffee.cart@example.com + defaultCurrency: GBP + phone: '0201111' + addresses: + - type: Billing + line1: 11 Coffee Lane + line2: Coffee Town + city: Coffee City + region: Hampshire + country: United Kingdom + postalCode: CC1 1CC + contacts: + - name: Coffee Carl + phone: + - number: '07733' + type: Mobile + status: Active + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2020-03-17T19:12:39Z' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + customerName: 7-Eleven + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + - id: '104957000000054050' + customerName: 'Doe, John' + contactName: John Doe + emailAddress: '' + defaultCurrency: GBP + addresses: [] + contacts: + - name: John Doe + email: '' + phone: [] + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-28T15:09:22' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-customers + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/data/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + summary: Get customer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomer' + examples: + Clear Books: + value: + id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + Exact (UK): + value: + id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + FreeAgent: + value: + id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + KashFlow: + value: + id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Oracle NetSuite: + value: + id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + QuickBooks Desktop: + value: + id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + QuickBooks Online Sandbox: + value: + id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + Sage 50 (UK): + value: + id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + Sage Intacct: + value: + id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-customer + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List customer attachments + description: |- + The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: list-accounting-customer-attachments + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get customer attachment + description: | + The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: get-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download customer attachment + description: |- + The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: download-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List direct costs + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCosts' + examples: + Clear Books: + value: + results: + - id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + - id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: 7d011ce8-89ae-43e7-a2ed-cf028534ccdc + note: 'Direct Cost with 4 line items, totaling 13684.57' + contactRef: + id: d3tf43eghS + dataType: suppliers + issueDate: '2022-05-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 148.88 + quantity: 5 + discountAmount: 73.62 + discountPercentage: 9.89 + subTotal: 670.78 + taxAmount: 67.08 + totalAmount: 737.86 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 82.68 + quantity: 3 + discountAmount: 0 + discountPercentage: 0 + subTotal: 248.04 + taxAmount: 24.8 + totalAmount: 272.84 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1192.51 + quantity: 8 + discountAmount: 0 + discountPercentage: 0 + subTotal: 9540.08 + taxAmount: 954.01 + totalAmount: 10494.09 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 9 + discountAmount: 0 + discountPercentage: 0 + subTotal: 1981.62 + taxAmount: 198.16 + totalAmount: 2179.78 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: + - id: costcode_1 + name: Green Concrete + paymentAllocations: + - payment: + id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + note: Payment for direct cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: Direct Cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-02T00:00:00' + totalAmount: 13684.57 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-02T00:00:00' + totalAmount: -13684.57 + subTotal: 12440.52 + taxAmount: 1244.05 + totalAmount: 13684.57 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-10-13T07:15:02' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + - id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + reference: INS000050 + note: '3915' + issueDate: '2022-05-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Utilities Expense + accountRef: + id: '31300' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 14.76 + quantity: 1 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T15:26:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 67 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + - id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:35:29Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 456 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + - id: '107509561' + reference: Buying pencils + note: Buying pencils + contactRef: + id: Pencils Wholesale + dataType: suppliers + issueDate: '2020-01-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Buying pencils + accountRef: + id: '3380551' + name: Supplies + unitAmount: 43.48 + quantity: 1 + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + trackingCategoryRefs: + - id: '5397997' + name: Supplies + paymentAllocations: [] + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:47' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + reference: '95' + contactRef: + id: 320000-933272659 + dataType: suppliers + issueDate: '2022-12-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 280000-933270542 + name: Freight & Delivery + unitAmount: 35 + quantity: 1 + subTotal: 35 + totalAmount: 35 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + tracking: + recordRefs: + - id: 40000-933272658 + dataType: trackingCategories + - id: 1E0000-933272658 + dataType: customers + paymentAllocations: + - payment: + id: DFA-933785132 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 250 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: PUR-3617 + reference: '2001' + contactRef: + id: '27' + dataType: suppliers + issueDate: '2015-11-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Insurance - general liability + accountRef: + id: '22' + name: Insurance Expense-General Liability Insurance + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + unitAmount: 750 + quantity: 1 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '3617' + note: '2001' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-27T00:00:00' + totalAmount: 900 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-27T00:00:00' + totalAmount: -900 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2022-08-19T10:19:56Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4460 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + - id: PUR-9303 + note: Payment to Google + contactRef: + id: '4' + dataType: suppliers + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '9303' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2022-07-11T10:32:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2176 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '52' + reference: '568953' + issueDate: '2021-01-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Vat Payment Quater End 3112.96 + accountRef: + id: '2202' + name: VAT Liability + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + unitAmount: 1497.58 + quantity: 1 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '52' + reference: '568953' + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 106 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + - id: 'CCTRANSACTION:4356' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62022' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4356' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-02-17T23:26:16' + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=2&pageSize=2 + Xero: + value: + results: + - id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + - id: 521c2396-7f74-404c-9cca-31115296b808 + reference: Eft + contactRef: + id: 74ea95ea-6e1e-435d-9c30-0dff8ae1bd80 + dataType: suppliers + issueDate: '2022-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Misc stationery + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + unitAmount: 18.09 + quantity: 1 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 521c2396-7f74-404c-9cca-31115296b808 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:51' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-direct-costs + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost' + examples: + Clear Books: + value: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + Sage 50 (UK): + value: + id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Intacct: + value: + id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + Xero: + value: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct cost* endpoint returns a single direct cost for a given directCostId. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-cost + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: get-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Download direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: download-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: List direct cost attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: list-accounting-direct-cost-attachments + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directIncomes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: List direct incomes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncomes' + examples: + Clear Books: + value: + results: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: ee4ea56f-8806-494d-9c69-7ec22e68dc5e + note: 'Direct Income with 4 line items, totaling 32095.91' + contactRef: + id: 453ddfc0-49ce-4f66-a815-dae734be885c + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 95.08 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 190.16 + taxAmount: 19.02 + totalAmount: 209.18 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + - id: department_3 + name: MarshallBrotherContracting + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1251.89 + quantity: 6 + discountAmount: 778.93 + discountPercentage: 10.37 + subTotal: 6732.41 + taxAmount: 673.24 + totalAmount: 7405.66 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 5563.88 + taxAmount: 556.39 + totalAmount: 6120.27 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 6 + discountAmount: 0 + discountPercentage: 0 + subTotal: 16691.64 + taxAmount: 1669.16 + totalAmount: 18360.8 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + note: Payment for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: Direct Income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 32095.91 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -32095.91 + subTotal: 29178.09 + taxAmount: 2917.81 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 518 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + - id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + reference: B110 + note: '4990' + issueDate: '2023-03-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Accounts Receivable + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 649.4 + quantity: -1 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + accountRef: + id: b6545a08-a9bd-ed11-9a88-0022484358c7 + name: HOLDING_LENDING + currency: GBP + currencyRate: 1 + paidOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-03-08T13:55:34Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes + FreeAgent: + value: + results: + - id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + - id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: '001' + name: Sales + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:13:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 211 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + - id: 68E0-1197775239 + reference: 96F3-1197775718 + contactRef: + id: 800000B5-1197701259 + dataType: customers + issueDate: '2023-01-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 361.08 + quantity: 1 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 68E0-1197775239 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-17T00:00:00' + totalAmount: 15281.67 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-17T00:00:00' + totalAmount: 361.08 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 104 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + - id: 5-2 + contactRef: + id: '53' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: funds borrowed to start business + accountRef: + id: '63' + name: Note Payable + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 25000 + quantity: 1 + discountAmount: 0 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-2 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 25000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -25000 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 741 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '11' + note: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + issueDate: '2018-10-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + accountRef: + id: '57' + name: Sales of Product Income + unitAmount: 8.12 + quantity: 1 + discountAmount: 0 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '11' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-10-15T00:00:00' + totalAmount: 8.12 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-10-15T00:00:00' + totalAmount: -8.12 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1171 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + - id: '5314' + reference: Test Int Income + note: Test Description + issueDate: '2022-03-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Interest earned + accountRef: + id: '5' + name: Other Income + unitAmount: 300 + quantity: 1 + subTotal: 300 + totalAmount: 300 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '5314' + note: Test Description + reference: Test Int Income + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + allocation: + currency: GBP + allocatedOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + modifiedDate: '2022-10-28T11:10:26Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=2&pageSize=2 + Xero: + value: + results: + - id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection.\n\n[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-direct-incomes + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: Get direct income + parameters: + - $ref: '#/components/parameters/accountingDirectIncomeId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncome' + examples: + Clear Books: + value: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Sage Intacct: + value: + id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + Xero: + value: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct income* endpoint returns a single direct income for a given directIncomeId. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-income + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Get direct income attachment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: get-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Download direct income attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: download-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + get: + tags: + - Accounts receivable + summary: List direct income attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: list-accounting-direct-income-attachments + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/data/info': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get company accounting profile + description: Gets the latest basic info for a company. + operationId: get-accounting-profile + x-speakeasy-name-override: get-accounting-profile + tags: + - Company info + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + accountingPlatformRef: 1700060034_ETD + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + taxNumber: '74111622555799035846' + financialYearStartDate: '2023-04-01T00:00:00' + baseCurrency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2020-03-09T15:19:26' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List invoices + description: "The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection.\n\n[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n \n### Useful queries\n\n- Outstanding invoices - `query = amountDue > 0`\n- Invoices due after a certain date: `query = dueDate > 2021-01-28`\n\n[Read more about querying](https://docs.codat.io/using-the-api/querying).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache.\n" + operationId: list-accounting-invoices + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoices' + examples: + Clear Books: + value: + results: + - id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + invoiceNumber: 4F6ONfFP + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-08-22T07:43:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x8.28 + unitAmount: 402.89 + quantity: 8.28 + subTotal: 3335.93 + taxAmount: 333.59 + totalAmount: 3669.52 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 3669.52 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -3669.52 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3335.93 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 333.59 + totalAmount: 3669.52 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 142 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: 31e97827-bb18-ed11-90eb-000d3a8747a0 + invoiceNumber: '102287' + customerRef: + id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + companyName: '' + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-08-10T14:46:08Z' + currency: USD + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + discountPercentage: 0 + status: Draft + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 368 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + - id: 0078bc15-10a4-433d-86fa-b1bb235fc0ab + invoiceNumber: '19700004' + customerRef: + id: 46951dc4-a170-42ce-bb38-9a80b776404f + companyName: Cust 03 + salesOrderRefs: [] + issueDate: '2019-11-13T00:00:00Z' + dueDate: '2019-12-04T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-13T11:47:51Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Standaard artikel - Standaard artikel + unitAmount: 25 + quantity: 1 + discountAmount: 0 + subTotal: 25 + taxAmount: 5.25 + totalAmount: 30.25 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 25 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5.25 + totalAmount: 30.25 + amountDue: 30.25 + discountPercentage: 0 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 5844 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + - id: 0981b5d1-a817-40be-a101-4848f7b1a258 + invoiceNumber: '17700004' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-03T00:00:00Z' + dueDate: '2017-09-02T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-03T12:22:27Z' + paidOnDate: '2017-08-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 150 + discountAmount: 0 + subTotal: 15000 + taxAmount: 0 + totalAmount: 15000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 15000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 15000 + amountDue: 0 + discountPercentage: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 4214 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '21974783' + invoiceNumber: '023' + customerRef: + id: '6162023' + companyName: Alderley plc + salesOrderRefs: [] + issueDate: '2017-01-09T00:00:00' + dueDate: '2017-02-08T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2023-02-06T15:31:38Z' + paidOnDate: '2023-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Laptop + unitAmount: 500 + quantity: 22 + discountAmount: 0 + subTotal: 11000 + taxAmount: 0 + totalAmount: 11000 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2 + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '214509356' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214338075' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327399' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327371' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214672049' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671769' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671495' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671482' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671308' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167014' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '215687795' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167064' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-12-02T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256992092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991833' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987893' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987069' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256983353' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256982947' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256955690' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256953648' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216464177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453277' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453273' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168080' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '260537850' + note: E2E Test transaction 19 DEBIT �250.00 - E2 E Test Transaction 19 - E2 E Test Transaction 19 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2020-10-23T00:00:00' + totalAmount: 235 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -225 + - payment: + id: '413909805' + note: �1.00 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2023-02-06T00:00:00' + totalAmount: 1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + subTotal: 11000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 11000 + amountDue: 10766.74 + status: PartiallyPaid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1449 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + - id: '2396753' + invoiceNumber: '0000062' + customerRef: + id: '512927' + companyName: Wood Turnerss + salesOrderRefs: [] + issueDate: '2016-04-04T00:00:00' + dueDate: '2016-04-04T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-02-24T07:34:31' + currency: GBP + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Submitted + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 172 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + - id: '143008597' + invoiceNumber: '41' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2010-01-01T00:00:00' + dueDate: '2010-01-29T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + paidOnDate: '2020-11-03T00:00:00' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '146438947' + note: '' + currency: EUR + paidOnDate: '2020-11-03T00:00:00' + totalAmount: 0 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: 0 + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 37 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + - id: '8529' + invoiceNumber: INV63 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2022-02-24T13:51:58' + paidOnDate: '2022-09-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '17588' + note: Payment Example - Invoice allocation + reference: 'Payment #PYMT90' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 10 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '17589' + note: Example - Payment of an invoice + reference: 'Payment #PYMT91' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '24558' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT109' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + - payment: + id: '24659' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT111' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + withholdingTax: [] + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 26 + amountDue: 5.8 + status: PartiallyPaid + pageNumber: 1 + pageSize: 2 + totalResults: 107 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: '469E-1071530054' + invoiceNumber: '978' + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + salesOrderRefs: [] + issueDate: '2022-11-30T00:00:00' + dueDate: '2023-12-30T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:09' + paidOnDate: '2023-01-10T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: See attached specification for details on work below. + unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Installation labor + unitAmount: 45.5 + quantity: 1 + subTotal: 45.5 + taxAmount: 0 + totalAmount: 45.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 20000-933272655 + name: Installation + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install drywall + unitAmount: 1320 + quantity: 1 + subTotal: 1320 + taxAmount: 0 + totalAmount: 1320 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 70000-933272656 + name: 'Subs:Drywall' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Electrical work + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 80000-933272656 + name: 'Subs:Electrical' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Metal Work + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: A0000-933272656 + name: 'Subs:Metal Wrk' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install insulation + unitAmount: 1100 + quantity: 1 + subTotal: 1100 + taxAmount: 0 + totalAmount: 1100 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 90000-933272656 + name: 'Subs:Insulating' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Plumbing + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: C0000-933272656 + name: 'Subs:Plumbing' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Painting + unitAmount: 2420 + quantity: 1 + subTotal: 2420 + taxAmount: 0 + totalAmount: 2420 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: B0000-933272656 + name: 'Subs:Painting' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install carpeting + unitAmount: 3300 + quantity: 1 + subTotal: 3300 + taxAmount: 0 + totalAmount: 3300 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 60000-933272656 + name: 'Subs:Carpet' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Custom Bay Window + unitAmount: 1925 + quantity: 1 + subTotal: 1925 + taxAmount: 0 + totalAmount: 1925 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Window + unitAmount: 115.5 + quantity: 1 + subTotal: 115.5 + taxAmount: 0 + totalAmount: 115.5 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Equipment Rental + unitAmount: 700 + quantity: 1 + subTotal: 700 + taxAmount: 0 + totalAmount: 700 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 230000-933272656 + name: Equip Rental + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: 10% retainage to be billed after job is complete and approved. + unitAmount: -555.5 + quantity: 1 + subTotal: -555.5 + taxAmount: 0 + totalAmount: -555.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 260000-933272656 + name: Retainage 1 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 6915-1197775450 + note: Check - 80000-933270541 + reference: '19650' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-10T00:00:00' + totalAmount: 14488.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14488.64 + withholdingTax: [] + totalDiscount: 0 + subTotal: 14330.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 158.14 + totalAmount: 14488.64 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + - id: '17' + invoiceNumber: '1002' + customerRef: + id: '2' + companyName: Software Coperation + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2019-02-21T17:51:49Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: IT Support + unitAmount: 80 + quantity: 40 + subTotal: 3200 + taxAmount: 0 + totalAmount: 3200 + accountRef: + id: '1' + name: Sales + itemRef: + id: '2' + name: Hours + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 3200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 3200 + amountDue: 3200 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 1326 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '3793' + invoiceNumber: 276e29c1 + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2022-08-22T13:04:50Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 15615 + status: Submitted + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1077 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + - id: '83515' + invoiceNumber: '0000000111' + customerRef: + id: BRO001 + companyName: Bronson Inc + salesOrderRefs: [] + issueDate: '2020-07-15T00:00:00Z' + dueDate: '2020-08-29T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-15T10:45:56Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Zero rated + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + taxRateRef: + id: '1728' + name: Zero rated + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 3.13 + subTotal: 125 + taxAmount: 0 + totalAmount: 125 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 3.13 + subTotal: 125 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 125 + amountDue: 125 + discountPercentage: 2.5 + status: Submitted + note: '0000000111' + pageNumber: 1 + pageSize: 2 + totalResults: 409 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: INV-9 + invoiceNumber: '9' + customerRef: + id: KIN001 + companyName: Kinghorn & French + salesOrderRefs: [] + issueDate: '2021-01-04T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 765 + quantity: 5 + discountAmount: 765 + subTotal: 3060 + taxAmount: 522.11 + totalAmount: 3582.11 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 5 + unitAmount: 1080 + quantity: 4 + discountAmount: 864 + subTotal: 3456 + taxAmount: 589.68 + totalAmount: 4045.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 6 + unitAmount: 1350 + quantity: 2 + discountAmount: 540 + subTotal: 2160 + taxAmount: 368.55 + totalAmount: 2528.55 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: FX030 Multifunctional Fax + unitAmount: 414 + quantity: 2 + discountAmount: 165.6 + subTotal: 662.4 + taxAmount: 113.02 + totalAmount: 775.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Premium Grade + unitAmount: 3.06 + quantity: 100 + discountAmount: 61.2 + subTotal: 244.8 + taxAmount: 41.77 + totalAmount: 286.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -276.57 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -765.42 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4035.68 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2518.55 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3527.11 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '9' + note: Sales credit tx-9 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -45 + withholdingTax: [] + totalDiscount: 2395.8 + subTotal: 9583.2 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1635.13 + totalAmount: 11218.33 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 86 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + - id: 6420b3f8209611e8b45c025132dab352 + invoiceNumber: SI-2 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2018-03-05T00:00:00' + dueDate: '2018-04-04T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2018-03-05T16:58:39Z' + paidOnDate: '2018-03-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 73a0490d209611e8b45c025132dab352 + note: Customer receipt using cash - PAYMENT-CASH-001 + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-03-05T00:00:00' + totalAmount: 5400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5400 + withholdingTax: [] + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + totalAmount: 5400 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 10759 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '18827' + invoiceNumber: IN1515 + customerRef: + id: '6' + companyName: AG Insurance + salesOrderRefs: [] + issueDate: '2022-09-28T00:00:00' + dueDate: '2022-10-28T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2022-10-05T11:02:22Z' + currency: USD + currencyRate: 0.9294 + lineItems: + - description: test desc Test05102022-1 + unitAmount: 180 + quantity: 1 + subTotal: 180 + taxAmount: 0 + totalAmount: 180 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '58' + name: EC Sale Goods Standard Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: CUSTOMER-6 + name: AG Insurance + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 180 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 180 + amountDue: 180 + status: Submitted + note: test desc Test05102022-1 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6ODgzOTc4MDA2NDIxMzUwODIx + invoiceNumber: '2' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM2OTkxOTYw + companyName: NIC Cookies + salesOrderRefs: [] + issueDate: '2020-03-05T00:00:00' + dueDate: '2020-03-05T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2020-03-30T14:10:21Z' + paidOnDate: '2020-03-30T14:10:21Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Decorated cookies + unitAmount: 4 + quantity: 50 + subTotal: 200 + taxAmount: 40 + totalAmount: 240 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6NDEzNzEwOTU= + name: Cookies + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 40 + totalAmount: 240 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=2&pageSize=2 + Xero: + value: + results: + - id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + invoiceNumber: INV-0001 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + salesOrderRefs: [] + issueDate: '2022-02-07T00:00:00' + dueDate: '2022-02-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T22:51:43' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Retainer for consulting work + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + reference: '' + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 500 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -500 + withholdingTax: [] + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + totalAmount: 500 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + - id: '104957000000038052' + invoiceNumber: INV-104 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:04' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-02-17T14:21:05' + paidOnDate: '2020-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000070175' + note: Cheque deposit + reference: '4' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 9001 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9001 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices/{invoiceId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoice' + examples: + Clear Books: + value: + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + Exact (UK): + value: + id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + FreeAgent: + value: + id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + FreshBooks: + value: + id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + KashFlow: + value: + id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + Oracle NetSuite: + value: + id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + QuickBooks Desktop: + value: + id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + QuickBooks Online Sandbox: + value: + id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + Sage 50 (UK): + value: + id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + Sage Intacct: + value: + id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + Xero: + value: + id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice + description: | + The *Get invoice* endpoint returns a single invoice for a given invoiceId. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + operationId: get-accounting-invoice + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/invoices/{invoiceId}/pdf': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/pdf: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice as PDF + description: "\uFEFF\x44\x6F\x77\x6E\x6C\x6F\x61\x64\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x73\x20\x61\x20\x70\x64\x66\x2E" + operationId: download-accounting-invoice-pdf + x-speakeasy-name-override: download-pdf + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List invoice attachments + description: |- + The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: list-accounting-invoice-attachments + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice attachment + description: | + The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: get-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download invoice attachment + description: | + The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: download-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/journalEntries': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journal entries + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntries' + examples: + Clear Books: + value: + results: + - id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + - id: 9f96606f-6846-40c6-b423-9b1753458e75 + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 188.33 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + netAmount: -17.12 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -171.21 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1862 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + - id: 01-2019 + postedOn: '2019-01-01T00:00:00' + createdOn: '2019-01-01T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: January 2019 + netAmount: -2000 + currency: GBP + accountRef: + id: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Checking account + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Salaries Expense + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Rent Expense + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 825 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + - id: 000154f0-e83a-4012-96a3-7db0b036b96b + createdOn: '2020-04-22T13:56:46' + updatedOn: '2020-04-22T13:56:46' + journalRef: + id: 151313ae-55b1-4ba0-b32a-e2ef6a8ce52a + name: Nominal Card + journalLines: + - description: Refunds with payment type of Cash + netAmount: -144.36 + currency: EUR + accountRef: + id: 0741cc89-e33a-4358-bcbd-3acb07b005dc + name: Nominal Card + tracking: + recordRefs: [] + - description: Refunds with payment type of Cash + netAmount: 144.36 + currency: EUR + accountRef: + id: ef2fde36-4416-4bc5-b239-315b2929348c + name: Debiteuren + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:08Z' + sourceModifiedDate: '2020-04-22T13:56:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 35972 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + - id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + createdOn: '2021-07-30T18:02:23' + updatedOn: '2021-07-30T18:02:23' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: 1038.01 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: cc0ab812-d89a-452b-88a8-61666a0f0211 + name: Accruals + tracking: + recordRefs: [] + - netAmount: -19.29 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - netAmount: -60.82 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 15.0 items with VatPercentage of 0.0 + netAmount: -248.28 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -8.97 + currency: GBP + accountRef: + id: 8f27a6b8-101d-4613-a059-2b462fb01b2f + name: anna_test_prod + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 5.0 + netAmount: -385.7 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 2 service charges with 0.0% vat + netAmount: -9.85 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 27.0 items with VatPercentage of 20.0 + netAmount: -304.1 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2021-07-30T18:02:23Z' + recordRef: + id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + dataType: invoices + pageNumber: 1 + pageSize: 2 + totalResults: 6785 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + - id: '24389396' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: -222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: 222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 734 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + - id: '7' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:02:18' + updatedOn: '2022-07-05T13:38:10' + journalLines: + - netAmount: -144 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '716' + name: Inventory In Transit + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - description: VAT + netAmount: 24 + currency: GBP + accountRef: + id: '211' + name: VAT on Purchases + tracking: + recordRefs: + - id: '713' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2022-07-05T13:38:10' + recordRef: + id: '7' + dataType: bills + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + - id: '469E-1071530054' + postedOn: '2022-11-30T00:00:00' + createdOn: '2022-11-30T00:00:00' + journalLines: + - description: '' + netAmount: 14488.64 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Installation labor + netAmount: -45.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: Install drywall + netAmount: -1320 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Electrical work + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Metal Work + netAmount: -660 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install insulation + netAmount: -1100 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Plumbing + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Painting + netAmount: -2420 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install carpeting + netAmount: -3300 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Custom Bay Window + netAmount: -1925 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -115.5 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Equipment Rental + netAmount: -700 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 10% retainage to be billed after job is complete and approved. + netAmount: 555.5 + currency: GBP + accountRef: + id: 70000-933270541 + name: Retainage Receivable + - description: 'CA sales tax, San Tomas County' + netAmount: -158.14 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:05:41' + recordRef: + id: '469E-1071530054' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Payment to Google + netAmount: -1.59 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: Payment to Google + netAmount: 1.59 + currency: GBP + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + recordRef: + id: PUR-15 + dataType: directCosts + pageNumber: 1 + pageSize: 2 + totalResults: 9405 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + - id: '13' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 7500 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: -7500 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:04Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9190 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + - id: '92' + description: Goods + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Goods/Services - Goods + netAmount: -5875 + currency: GBP + accountRef: + id: '2100' + name: Creditors Control Account + - description: Goods/Services - Goods + netAmount: 5000 + currency: GBP + accountRef: + id: '5000' + name: Materials Purchased + - description: Goods/Services - Goods + netAmount: 875 + currency: GBP + accountRef: + id: '2201' + name: Purchase Tax Control Account + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '92' + dataType: bills + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1119 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + - id: c23efa4233de11e797950a57719b2edb + postedOn: '2017-05-08T11:09:09' + createdOn: '2017-05-08T11:09:09' + updatedOn: '2017-05-08T11:09:09' + journalLines: + - netAmount: 1080 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + - description: Consulting services + netAmount: -180 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: -900 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:09:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24386 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + - id: '262179' + description: 'Receipts(Bank-501_CHK) - 1100: April 2021 Batch Summary Entry' + postedOn: '2021-04-30T00:00:00' + createdOn: '2021-04-22T11:01:11' + updatedOn: '2022-04-19T13:38:45' + journalRef: + id: '7' + name: Cash Receipts Journal + journalLines: + - description: '' + netAmount: -120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: 150 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: -150 + currency: GBP + accountRef: + id: '179' + name: Revenue - Other + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-19T13:38:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=2&pageSize=2 + Xero: + value: + results: + - id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + - id: 98ac5060-c9ed-4359-bcd5-711e649e7899 + postedOn: '2021-12-20T00:00:00' + createdOn: '2023-02-17T21:07:23' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + - description: '' + netAmount: 7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:23' + recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 290 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-journal-entries + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journalEntries/{journalEntryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: journalEntryId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a journal entry. + get: + tags: + - Transactions + summary: Get journal entry + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntry' + examples: + Clear Books: + value: + id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + Exact (UK): + value: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + FreshBooks: + value: + id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + QuickBooks Desktop: + value: + id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + QuickBooks Online Sandbox: + value: + id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + Sage Intacct: + value: + id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + Xero: + value: + id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. + + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal-entry + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journals': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journals + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournals' + examples: + Clear Books: + value: + results: + - id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + - id: 07b94827-c0a5-4cc7-ba58-3f9efec3b4b3 + journalCode: PAY + name: Payroll Journal + type: Payroll Journal + parentId: 90bb7784-083b-4bcb-a534-b30756cee65d + hasChildren: false + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-24T14:17:02' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + Dynamics 365 Business Central: + value: + results: + - id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + - id: 9a94ef78-92ec-ec11-82f9-000d3a8746a9 + journalCode: BNKDEPOSIT-BNKD + name: BNKD + type: Bank Deposits + parentId: af7d7e6b-e5c8-ec11-8e7e-000d3a86e04a + hasChildren: false + createdOn: '2022-06-15T10:03:59' + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-15T22:45:30Z' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 46 + Exact (Netherlands): + value: + results: + - id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + - id: 74677165-1bd3-49b4-87d0-32d974674f86 + journalCode: '23' + name: Abraham's Billion Dollar stuff + type: Bank + hasChildren: false + createdOn: '2019-11-22T13:35:57' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2019-11-22T13:35:57Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 47 + Exact (UK): + value: + results: + - id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + - id: b9c3d6a6-4ce2-4714-9ff6-fb15892300f7 + journalCode: '31' + name: annaBankAccount10 + type: Bank + hasChildren: false + createdOn: '2021-05-18T10:24:18' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-05-18T10:24:18Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + Sage Intacct: + value: + results: + - id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + - id: '223' + journalCode: AJPT2 + name: A Journal Push Test 2 + type: '' + hasChildren: false + createdOn: '2022-01-18T15:39:07' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-18T15:39:07' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 1211 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-journals + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/journals/{journalId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: Get journal + parameters: + - name: journalId + in: path + required: true + schema: + type: string + description: Unique identifier for a journal. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournal' + examples: + Clear Books: + value: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + Exact (UK): + value: + id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + Sage Intacct: + value: + id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal* endpoint returns a single journal for a given journalId. + + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/payments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayments' + examples: + Clear Books: + value: + results: + - id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + - id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + paymentMethodRef: + id: 8db2de81-0db4-46ee-b7f9-c711a7e89a01 + name: Cash payments-IHz + totalAmount: 1772.72 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + lines: + - amount: 1772.72 + links: + - type: Invoice + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + amount: -1772.72 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 200 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + - id: 042a9ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Adatum Corporation + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 600.48 + currency: GBP + currencyRate: 1 + date: '2019-01-16T00:00:00' + note: Invoice 102002 + lines: + - amount: 600.48 + links: + - type: Invoice + id: 1bc906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -600.48 + currencyRate: 1 + allocatedOnDate: '2019-01-16T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103002' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 249 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + - id: 1650bb9c-5d9a-40f2-9015-0e251a12f861_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 991.56 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 991.56 + links: + - type: Invoice + id: 013f05e6-2583-4e6d-8309-a479808cf7bf + amount: -991.56 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:12Z' + reference: '19230010' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + - id: d8b093cf-3d37-405b-9e85-72552226553f_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T09:58:15Z' + reference: '20200001' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + - id: '135258250' + customerRef: + id: '6162230' + companyName: Stronachs LLP + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 006' + lines: + - amount: 100 + links: + - type: Invoice + id: '21952246' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1146 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + - id: '988600' + customerRef: + id: '380630' + totalAmount: 5 + currency: GBP + date: '2019-01-21T00:00:00' + note: 'Overpayment: invoice #0000007' + lines: + - amount: 5 + links: + - type: PaymentOnAccount + id: '380630' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2019-01-21T10:23:59' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + - id: '86861497' + customerRef: + id: '69946501' + companyName: Peter Lord + totalAmount: 10 + currency: GBP + date: '2017-05-01T00:00:00' + note: '' + lines: + - amount: 10 + links: + - type: Invoice + id: '85315064' + amount: -10 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 2 + totalResults: 74 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + - id: '428' + customerRef: + id: '417' + companyName: 10 Breww Ltd + accountRef: + id: '122' + name: Undeposited Funds + totalAmount: 90 + currency: GBP + currencyRate: 1 + date: '2021-04-20T00:00:00' + lines: + - amount: 90 + links: + - type: Invoice + id: '416' + amount: -90 + currencyRate: 1 + - amount: 10 + links: + - type: Invoice + id: '416' + amount: -10 + currencyRate: 1 + - amount: -10 + links: + - type: Other + id: '428' + amount: 10 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-04-28T13:36:54' + reference: 'Payment #PYMT01' + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + - id: 6973-1197775625 + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 431.95 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 431.95 + links: + - type: Invoice + id: 2453-1071526256 + amount: -431.95 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '983409' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 108 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + - id: '9298' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Adeel Test + lines: + - amount: 95.2 + links: + - type: PaymentOnAccount + id: '9' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:18Z' + sourceModifiedDate: '2022-06-20T13:51:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3723 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + - id: '31' + customerRef: + id: '59' + companyName: Ecker Holiday event + accountRef: + id: '81' + name: Current + totalAmount: 15615 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 15615 + links: + - type: Invoice + id: '30' + amount: -15615 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2016-09-12T16:50:17Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 813 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + - id: '29681' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-12-31T00:00:00Z' + note: Opening Balance + lines: + - amount: 0 + links: + - type: Invoice + id: '29745' + amount: 0.05 + currencyRate: 1 + - type: CreditNote + id: '29681' + amount: -0.05 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: O/BAL + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '8' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + accountRef: + id: '' + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-12-31T00:00:00' + note: Sales credit tx-8 linked to sales invoice inv-10. + lines: + - amount: 0 + links: + - type: Invoice + id: INV-10 + amount: -0.05 + currencyRate: 1 + - type: CreditNote + id: TX-8 + amount: 0.05 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + - id: 03a5fdc8baa643fb97587033b0c4590b + customerRef: + id: 3cc3148bbd8111e8bad90617b3da4b8a + companyName: John's Test Customer + accountRef: + id: 2572c8766afc11e8aaa5027d54329956 + name: Tide Current + totalAmount: 100 + currency: GBP + currencyRate: 1 + date: '2017-11-23T00:00:00' + note: Customer receipt using credit/debit card + lines: + - amount: 100 + links: + - type: Invoice + id: ede1e735bd8111e8bad90617b3da4b8a + amount: -100 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2019-01-17T14:14:55Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2321 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + - id: '6105' + customerRef: + id: '531' + companyName: Shoprite + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '6' + name: Cash + totalAmount: 150 + currency: GBP + date: '2022-04-19T00:00:00' + note: '' + lines: + - amount: 150 + links: + - type: PaymentOnAccount + id: '531' + amount: -150 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2022-04-19T13:38:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments + Xero: + value: + results: + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + - id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 500 + links: + - type: Invoice + id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + amount: -500 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:51:43' + reference: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + - id: '104957000000067014' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-14T00:00:00' + note: '' + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038106' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '1' + pageNumber: 1 + pageSize: 2 + totalResults: 33 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-payments + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/paymentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + Clear Books: + value: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + Exact (UK): + value: + id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + FreeAgent: + value: + id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + KashFlow: + value: + id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + Oracle NetSuite: + value: + id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + QuickBooks Desktop: + value: + id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + QuickBooks Online Sandbox: + value: + id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + Sage 50 (UK): + value: + id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + Sage Intacct: + value: + id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + Xero: + value: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get payment + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-payment + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List suppliers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSuppliers' + examples: + Clear Books: + value: + results: + - id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: FyUkHbZxhn + supplierName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + phone: 0116 796 3163 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '0177-04-27T11:56:00' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 100 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: be49ec62-6754-ed11-946f-0022481b67d1 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2022-10-25T13:17:36Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 31 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + - id: 00014c12-2616-481a-a2e8-31bdf2497775 + supplierName: Ann's test supplier 2 + contactName: Ann's contact name + emailAddress: anna@anna888888.com + phone: '55555555' + addresses: + - type: Billing + line1: line1 + line2: line2 + city: city + region: region + country: RU + postalCode: postal + registrationNumber: '55566677788899944455' + taxNumber: RU4444444 + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-09T12:04:08Z' + defaultCurrency: USD + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + - id: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2020-05-01T14:05:46Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 118 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + - id: '9677150' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-24T06:19:23' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + - id: DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA== + 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' + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + - id: '9338173' + supplierName: Home + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '1990-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + - id: '726' + supplierName: Vendor -.A + contactName: Vendor -.A + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2021-03-26T09:53:15' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: A40000-1197774038 + supplierName: Bank of Anycity + contactName: Lisa D. Holzhauser + emailAddress: lisah@samplename.com + phone: 415-555-9135 + addresses: + - type: Billing + line1: 'Bank of Anycity, Lisa Holzhauser' + line2: 1935 Main Street + city: Middlefield + region: CA + postalCode: '94482' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 54 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + - id: '42' + supplierName: AI Support 2 + contactName: AI Support 2 + addresses: + - type: Billing + line1: test + region: string + country: DJ + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2021-08-31T08:45:02Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 23 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: '88' + supplierName: Andrew Haberbosch + addresses: [] + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2022-07-06T15:55:28Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + - id: '914' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + pageNumber: 1 + pageSize: 2 + totalResults: 943 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: MCN001 + supplierName: McNally Computer Supplies + contactName: Stuart Lynn + emailAddress: newbusinessadvice@sage.com + phone: 0191 415 3434 + addresses: + - type: Delivery + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + - type: Unknown + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + taxNumber: GB455 2385 34 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-12-05T13:37:26Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + - id: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + contactName: Abdi + emailAddress: abdisupplier@company.com + addresses: + - type: Billing + line1: 1 Place House + city: London + country: United Kingdom (GB) + postalCode: WC1X 1AH + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-13T10:38:19Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + - id: '29' + supplierName: Advisor Printing + contactName: 'Roach, Nathan' + phone: 130-202-4796 + addresses: + - type: Unknown + line1: 5 Carey Hill + line2: '' + city: Drayton Valley + region: Alberta + country: Canada + postalCode: G8V + registrationNumber: '' + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2022-06-15T11:38:29' + defaultCurrency: CAD + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx + supplierName: Flour Mill + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:12:40Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + supplierName: 7-Eleven + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + - id: '104957000000648001' + supplierName: Cool company + contactName: Dre + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-10T09:07:16' + defaultCurrency: CAD + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-suppliers + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/data/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + summary: Get supplier + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Clear Books: + value: + id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + Exact (UK): + value: + id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + FreeAgent: + value: + id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + FreshBooks: + value: + id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + Oracle NetSuite: + value: + id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + QuickBooks Desktop: + value: + id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + QuickBooks Online Sandbox: + value: + id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + Sage 50 (UK): + value: + id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + Sage Intacct: + value: + id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get supplier* endpoint returns a single supplier for a given supplierId. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-supplier + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List supplier attachments + description: | + The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: list-accounting-supplier-attachments + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get supplier attachment + description: | + The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: get-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download supplier attachment + description: | + The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: download-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List transfers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfers' + examples: + Clear Books: + value: + results: + - id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + - id: 78373000-29e1-4ef4-a2e6-9b573ed656e4 + description: depositing 188.33 into Current Account + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 357 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + - id: TST-001 + date: '2022-10-25T00:00:00' + from: + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + dataType: bankAccounts + currency: USD + amount: 3.6 + status: Unknown + to: + accountRef: + id: 8982e7d8-cb19-eb11-bbf9-0022481ad2f4 + dataType: bankAccounts + currency: GBP + amount: 2.34 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2022-10-25T15:47:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + - id: '308682395' + description: Transfer from Business Current Account to Nic Test11 + date: '2019-12-23T00:00:00' + from: + accountRef: + id: '469976' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + to: + accountRef: + id: '691393' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-31T16:09:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 99 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + - id: 2-11822 + contactRef: + id: '417' + dataType: customers + date: '2022-04-28T00:00:00' + from: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + to: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '7526' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T14:14:33' + pageNumber: 1 + pageSize: 2 + totalResults: 47 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + - id: C2A-933780606 + description: Funds Transfer + date: '2024-11-25T00:00:00' + from: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + to: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:04:07' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + - id: '678' + date: '2020-08-22T00:00:00' + from: + accountRef: + id: '124' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + to: + accountRef: + id: '109' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-29T00:01:20Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 442 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + - id: '1885' + date: '2020-09-02T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:23:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + - id: 73d909a4215a11e8b45c025132dab352 + description: Some cash + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:21:40Z' + pageNumber: 1 + pageSize: 2 + totalResults: 646 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + - id: '18828' + description: From bank account '700_CHK' to bank account 'Test Savings Account' + date: '2022-10-05T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 4040.62 + status: Unknown + to: + accountRef: + id: 'SAVINGSACCOUNT:17' + dataType: bankAccounts + currency: GBP + amount: 200 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-10-05T15:28:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection.\n\n[Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-transfers + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transferId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transfer. + get: + tags: + - Transactions + summary: Get transfer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + Clear Books: + value: + id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + QuickBooks Desktop: + value: + id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + Sage Business Cloud Accounting: + value: + id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + Sage Intacct: + value: + id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transfer* endpoint returns a single transfer for a given transferId. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-transfer + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank accounts + operationId: list-accounting-bank-accounts + x-speakeasy-group: accounting-bank-data.accounts + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccounts' + examples: + Dynamics 365 Business Central: + value: + results: + - id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + - id: 47020f80-60e6-ec11-82f8-0022481a77f0 + accountName: '555' + accountType: Unknown + nominalCode: '40300' + sortCode: '' + accountNumber: '' + iBan: '' + currency: PLN + balance: 661.79 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 28 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + - id: '738778' + accountName: 2e2bna45hy\ + accountType: Debit + sortCode: '236972' + accountNumber: D01825250 + currency: GBP + balance: -114.4 + availableBalance: -114.4 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '765766' + accountName: 1a1a + accountType: Unknown + nominalCode: '70600' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 56 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + - id: '826' + accountName: Codat Europe Bank USD + accountType: Debit + nominalCode: '1133221133' + currency: USD + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2021-03-26T10:31:40' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + - id: 550001-1071509830 + accountName: Petty Cash + accountType: Unknown + nominalCode: '10400' + currency: GBP + balance: 500 + availableBalance: 500 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + - id: '163' + accountName: '11' + accountType: Debit + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + - id: '193' + accountName: 1 year ago + accountType: Debit + currency: GBP + balance: 5300.02 + availableBalance: 5300.02 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2023-01-18T06:05:12Z' + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + - id: '1210' + accountName: Bank Deposit Account + accountType: Unknown + nominalCode: '1210' + sortCode: 45-45-45 + accountNumber: 9/00474345 + iBan: '' + currency: GBP + balance: 3510 + availableBalance: 3510 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 0 + institution: Halifax Building Society + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + - id: 565ce07212bc492c8c2d04f43f9f67e3 + accountName: Abdi Live Test + accountType: Unknown + nominalCode: '147852' + sortCode: '123456' + accountNumber: '1234567' + currency: GBP + balance: -225830.75 + availableBalance: -225830.75 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + - id: 'CREDITCARD:58' + accountName: Cot Credit Card 2 + accountType: Credit + nominalCode: '11112' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:15:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + accountName: Business Savings Account + accountType: Debit + sortCode: '890303' + accountNumber: '876543210' + currency: GBP + balance: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:36:06' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts + Zoho Books: + value: + results: + - id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + - id: '104957000000065002' + accountName: Abdi Test 2 + accountType: Unknown + sortCode: '' + accountNumber: '' + currency: AED + balance: 98.03 + modifiedDate: '2022-10-03T08:40:38Z' + institution: '' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection.\n\n[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + x-internal: true + tags: + - Accounting bank data + summary: Get bank account + operationId: get-accounting-bank-account + x-speakeasy-group: accounting-bank-data.accounts + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: + Dynamics 365 Business Central: + value: + id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + FreeAgent: + value: + id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + QuickBooks Desktop: + value: + id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + Oracle NetSuite: + value: + id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + Sage Intacct: + value: + id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bank account* endpoint returns a single account for a given accountId. + + [Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions': + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank account transactions + description: | + The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: list-accounting-bank-account-transactions + x-speakeasy-name-override: list-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankTransactions' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 07c891b4-f67a-ed11-9989-0022481ae525 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 1 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 5ced3895-f77a-ed11-9989-0022481b6241 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 2 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: cd12966b-8871-ed11-8c34-6045bd0c6935 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-12-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -17 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: b13392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -30 + balance: -72 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b3696a16-1fa2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -10 + balance: -122 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b73392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child + reconciled: false + amount: -40 + balance: -112 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: befdd569-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -13 + balance: -160 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: cb71c33a-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -25 + balance: -147 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: e7ec12c9-94a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -10 + balance: -27 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: fef7a026-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -15 + balance: -42 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 20869cb1-39a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: Accounts Payable + reconciled: false + amount: -14 + balance: -184 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 8c298754-20a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -170 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935d5578-3ca2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -201 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935f4303-e3a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -239 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: d8ceb342-dba2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -21 + balance: -222 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: 15719c0c-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -292.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 213d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -9.35 + balance: -265.19 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 273d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: -7.5 + balance: -272.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978c4a27-e0a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 2.16 + balance: -236.84 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: a80f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -7.01 + balance: -262.85 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ad0f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: 7.01 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b5de7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -4.91 + balance: -260.75 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: bbde7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 4.91 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f9540bf4-e5a2-ed11-9a88-000d3ad5d945 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: feca50d8-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-06T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -312.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 4777d7ec-cfa6-ed11-9a88-000d3a7fb2e5 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-07T00:00:00' + description: '' + reconciled: false + amount: -2.34 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 38b632de-7aac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: Invalid VAT Posting Setup + reconciled: false + amount: -10 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ffc0b740-68a8-ed11-9a88-6045bdd12fc1 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: '' + reconciled: false + amount: 10 + balance: -305.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 95f27455-7cac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-14T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -325.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 0d6b1378-acae-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-16T00:00:00' + description: Bank Account Line + reconciled: false + amount: -12 + balance: -337.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978da9f7-baae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: 6 + balance: -342.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: dd34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: G/L + reconciled: false + amount: -1 + balance: -338.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Customer + reconciled: false + amount: 2 + balance: -336.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e734e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Vendor + reconciled: false + amount: -3 + balance: -339.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ed34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: -4 + balance: -343.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Employee + reconciled: false + amount: -5 + balance: -348.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 39de1293-d3b1-ed11-9a88-6045bd0f94d6 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-21T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -352.03 + transactionType: Credit + modifiedDate: '2023-03-27T14:21:19Z' + pageNumber: 1 + pageSize: 100 + totalResults: 37 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + FreeAgent: + value: + results: + - id: '261197890' + accountId: '738783' + clearedOnDate: '2020-10-28T00:00:00' + description: Invoice receipt against 1762 + reconciled: true + amount: 111 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2020-10-28T16:27:10Z' + - id: '290878530' + accountId: '738783' + clearedOnDate: '2021-04-23T00:00:00' + description: Invoice receipt against 1980 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:42Z' + - id: '290825614' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1976 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-26T14:05:15Z' + - id: '290878531' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1981 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:44Z' + - id: '291227300' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2002 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T13:43:56Z' + - id: '291242296' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2012 + reconciled: true + amount: 40 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T16:14:16Z' + - id: '346437532' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T14:59:40Z' + - id: '346444438' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:37:54Z' + - id: '346444989' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:41:22Z' + - id: '346457774' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Credit Note refund against 2313 + reconciled: true + amount: -1 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:07:50Z' + - id: '346458196' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2311 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:14:15Z' + - id: '414441841' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'MCDONALDS - ROYSTON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -12.78 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441842' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -7.98 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441845' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -648.63 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441847' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -324.31 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441849' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'RUGBY, PRET A MANGER - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441851' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'Just Eat - London - Card Ending: 9271//OTHER/' + reconciled: false + amount: -22.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441852' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'CN TAR TAROM SA-MOBILP - ORAS OTOPENI - Card Ending: 4999//OTHER/' + reconciled: false + amount: -340.13 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441854' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'MOTO RUGBY SERVICES - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -126.12 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441855' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'POMANDA.COM - 138 HOLBORN, - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441856' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'RYANAIR 224BEZ3YM - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -267.97 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441857' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441859' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'SPOTIFY - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -16.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441860' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'Revive My Device - London - Card Ending: 5913//OTHER/' + reconciled: false + amount: -149 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441861' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -39.36 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441862' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.4 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441863' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'Amazon.co.uk*1N0N04VK4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.76 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441864' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441865' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -16.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441866' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -4.55 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441867' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TRAVELODGE GB0937 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441868' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -34.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441869' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441870' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SIDS DIY - LONDON E1 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -5.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441871' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'RESOLUTION GB LTD - WHITCHURCH - Card Ending: 2327//OTHER/' + reconciled: false + amount: -368.72 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441872' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441874' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -5.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441875' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 6.8 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441876' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 12.49 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441877' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441878' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -27.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441879' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441880' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -25.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441881' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'CREAMLINE DAIRIES ONLINE - MANCHESTER - Card Ending: 2327//OTHER/' + reconciled: false + amount: -50 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441883' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'AIRBNB * HMYDEXRY4N - 203-318-1111 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -388.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441884' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441886' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441889' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.84 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441891' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'WELCOME BREAK - NEWPORT PAGNE - Card Ending: 9271//OTHER/' + reconciled: false + amount: -102.23 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441892' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'SUBWAY 63582 London Gatew - Mill Hill, Lo - Card Ending: 9271//OTHER/' + reconciled: false + amount: -15.38 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441893' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -40.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441894' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441895' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -34.06 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441897' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441901' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Tesla - West Drayton - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441904' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Box Deansgate - Manchester - Card Ending: 0614//OTHER/' + reconciled: false + amount: -20.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441906' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'MANCHESTER UNITED KIOSK - MANCHESTER - Card Ending: 0614//OTHER/' + reconciled: false + amount: -26.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441908' + accountId: '738783' + clearedOnDate: '2022-12-29T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441909' + accountId: '738783' + clearedOnDate: '2022-12-31T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -1.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441910' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441911' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -11.95 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441912' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -13.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441913' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441914' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.14 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441915' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'GOOGLE*GSUITE ISOMI.CO - DUBLIN 2 - Card Ending: 1332//OTHER/' + reconciled: false + amount: -216.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441916' + accountId: '738783' + clearedOnDate: '2023-01-03T00:00:00' + description: 'Refund: AMZ*quickpickdeals - amazon.co.uk - Card Ending: 4999//OTHER/' + reconciled: false + amount: 10.97 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441917' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: Finance Charge//OTHER/ + reconciled: false + amount: -0.41 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441918' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441919' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -86.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441920' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441922' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'AMAZON PRIME*164AU3UZ4 AM - AMZN.CO.UK/PM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -96 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441924' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162DC7II4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -44.62 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441926' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'trainline - +443332022222 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -65.46 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441931' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'VITAL PARTS LTD - MAIDSTONE - Card Ending: 2327//OTHER/' + reconciled: false + amount: -124.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441934' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*168E49IU4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441935' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -108.16 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441936' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Refund: ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: 22.96 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441937' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H31B0CO4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -20.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441939' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H4GR4CH4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -13.69 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441941' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162V47WY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -16.83 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441945' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*160J00WI4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441946' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*1692Y9YY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441947' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*166I62Y14 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441948' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'GMELIUS GROWTH - MEYRIN - Card Ending: 5913//OTHER/' + reconciled: false + amount: -121.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441949' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -116.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441950' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -66.79 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441951' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'TOOLSTATION UK - NORTHAMPTON - Card Ending: 2327//OTHER/' + reconciled: false + amount: -77.88 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441952' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'SHELL CHESTER - CHESTER - Card Ending: 9271//OTHER/' + reconciled: false + amount: -112.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441953' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1252150515112 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -450.85 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441954' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1254217966962 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441955' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441956' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'Amazon.co.uk*1H97Y6TL4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441957' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -15.03 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441959' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -16.43 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441960' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: Payment made (BACS)//OTHER/ + reconciled: false + amount: 5000 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441961' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -32.57 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441962' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TESCO STORES - LONDON - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441963' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'VICTORIA INN - PECKHAM - Card Ending: 5913//OTHER/' + reconciled: false + amount: -15.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441965' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -7.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441967' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'PRET A MANGER - 326 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -13.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + pageNumber: 1 + pageSize: 100 + totalResults: 153 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions?page=2&pageSize=100 + KashFlow: + value: + results: + - id: '765768:137014109' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: FIRST Transaction + reconciled: false + amount: 100 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:137014143' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: SECOND Transaction + reconciled: false + amount: 120 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:93269803' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: 'KF00021:' + reconciled: false + amount: -5 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:141203309' + accountId: '765768' + clearedOnDate: '2020-06-18T00:00:00' + description: 'INV #33: Customer overpayment' + reconciled: false + amount: 110 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:144653342' + accountId: '765768' + clearedOnDate: '2020-10-23T00:00:00' + description: '' + reconciled: false + amount: 1 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 100 + totalResults: 5 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + accountId: 20000-933270541 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + reconciled: false + amount: -1200 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:10' + - id: DFA-933785132 + accountId: 20000-933270541 + clearedOnDate: '2022-12-05T00:00:00' + description: '' + reconciled: false + amount: -35 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: E2E-933785785 + accountId: 20000-933270541 + clearedOnDate: '2022-12-10T00:00:00' + description: '' + reconciled: false + amount: -197.59 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: 536B-1197755199 + accountId: 20000-933270541 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + reconciled: false + amount: -2100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:47' + - id: 5C18-1197711471-to + accountId: 20000-933270541 + clearedOnDate: '2022-12-31T00:00:00' + description: Opening Balance - Bank Balance - Checking Account + reconciled: false + amount: 27874.62 + transactionType: Other + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:06' + - id: 3A09-1071529982 + accountId: 20000-933270541 + clearedOnDate: '2023-01-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 95C6-1197729008 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: 941 Deposit for December 2005 Payyroll + reconciled: false + amount: -3495.82 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95CA-1197729081 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: FUTA Payment - 4 Qrt 2005 + reconciled: false + amount: -100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D0-1197729222 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: State Unemployment and Disability - 4th Quarter 2005 + reconciled: false + amount: -208.09 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D4-1197729376 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Worker's Compensation - 4th Quarter 2005 + reconciled: false + amount: -1214.31 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 9C06-1181931827 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Deposit + reconciled: false + amount: 1228.18 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E3A-1182063799 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -308.34 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: A293-1197953458 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -12362.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AB-1197953786 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -9521 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A33E-1197955762 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -3146.88 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 6992-1197775718 + accountId: 20000-933270541 + clearedOnDate: '2023-01-17T00:00:00' + description: Deposit + reconciled: false + amount: 15281.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3E5D-1071498699 + accountId: 20000-933270541 + clearedOnDate: '2023-01-21T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: 699D-1197775731 + accountId: 20000-933270541 + clearedOnDate: '2023-01-25T00:00:00' + description: Deposit + reconciled: false + amount: 31474.25 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 53D-933354764 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:00' + - id: 9E3D-1182131998 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -205 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E42-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -532 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E47-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -623 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E4C-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -13759 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED6-1182133365 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Fuel + reconciled: false + amount: -138 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F2D-1197948760 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Vehicle Repairs and Maintenance + reconciled: false + amount: -218 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F96-1197949640 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -123.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: A2CD-1197955250 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Pmt# 1 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: F29-933787474 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:13' + - id: 698D-1197775698 + accountId: 20000-933270541 + clearedOnDate: '2023-02-02T00:00:00' + description: Deposit + reconciled: false + amount: 1040 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 69A8-1197775740 + accountId: 20000-933270541 + clearedOnDate: '2023-02-09T00:00:00' + description: Deposit + reconciled: false + amount: 271.53 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3A10-1071529997 + accountId: 20000-933270541 + clearedOnDate: '2023-02-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: A0BD-1197950967 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -268.39 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AF-1197953842 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -4050.98 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A343-1197955826 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -1466.32 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C0B-1181931843 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Deposit + reconciled: false + amount: 25471.56 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E63-1182132109 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: For Vetter Basement Remodel + reconciled: false + amount: -2050 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED9-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Fuel + reconciled: false + amount: -142 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F33-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -222 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F99-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -125.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FBD-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A052-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A081-1197950831 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D1-1197955271 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Pmt# 2 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A17-1071530007 + accountId: 20000-933270541 + clearedOnDate: '2023-03-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 9C38-1182054225 + accountId: 20000-933270541 + clearedOnDate: '2023-03-13T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: A296-1197953484 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: '' + reconciled: false + amount: -1600 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A346-1197955854 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -83.6 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C10-1181931855 + accountId: 20000-933270541 + clearedOnDate: '2023-03-20T00:00:00' + description: Deposit + reconciled: false + amount: 6278.8 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E72-1182132247 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: '' + reconciled: false + amount: -435 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9EDC-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Fuel + reconciled: false + amount: -127 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F36-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7B-1197949443 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9C-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -389.2 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC0-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A056-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A084-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D5-1197955280 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Pmt# 3 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A1E-1071530019 + accountId: 20000-933270541 + clearedOnDate: '2023-04-12T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 4271-1071523732 + accountId: 20000-933270541 + clearedOnDate: '2023-04-17T00:00:00' + description: '' + reconciled: false + amount: -714 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:32' + - id: 3E98-1071499056 + accountId: 20000-933270541 + clearedOnDate: '2023-04-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:11' + - id: 9C68-1182054440 + accountId: 20000-933270541 + clearedOnDate: '2023-04-20T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 9EDF-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Fuel + reconciled: false + amount: -162 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F39-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -192 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9F-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -120.93 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC3-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05A-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A087-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D9-1197955286 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Pmt# 4 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C86-1182054823 + accountId: 20000-933270541 + clearedOnDate: '2023-05-01T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 3A25-1071530029 + accountId: 20000-933270541 + clearedOnDate: '2023-05-13T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: A0C0-1197950991 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -950.23 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A299-1197953515 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -1400 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A349-1197955899 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -318.02 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CB8-1182055085 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 9EE2-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Fuel + reconciled: false + amount: -143 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3C-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA2-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC6-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05E-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08A-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2DD-1197955294 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Pmt# 5 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CBD-1182055262 + accountId: 20000-933270541 + clearedOnDate: '2023-06-06T00:00:00' + description: '' + reconciled: false + amount: -5275 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 3A2C-1071530042 + accountId: 20000-933270541 + clearedOnDate: '2023-06-10T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 5356-1197761596 + accountId: 20000-933270541 + clearedOnDate: '2023-06-16T00:00:00' + description: '' + reconciled: false + amount: -1786 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:46' + - id: 9EE5-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Fuel + reconciled: false + amount: -157 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3F-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -186 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7E-1197949458 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA5-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -135.02 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC9-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A062-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08D-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2E1-1197955306 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Pmt# 6 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A33-1071530066 + accountId: 20000-933270541 + clearedOnDate: '2023-07-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 3E67-1071498733 + accountId: 20000-933270541 + clearedOnDate: '2023-07-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: A0C3-1197951027 + accountId: 20000-933270541 + clearedOnDate: '2023-07-23T00:00:00' + description: '' + reconciled: false + amount: -239.29 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: 9EE8-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Fuel + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F42-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA8-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FCC-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A066-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + pageNumber: 1 + pageSize: 100 + totalResults: 495 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions?page=2&pageSize=100 + Sage 50 (UK): + value: + results: + - id: '73' + accountId: '1200' + clearedOnDate: '2021-01-29T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -10164.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '52' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '568953' + reconciled: false + amount: -1497.58 + balance: -10302.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '53' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '5897532' + reconciled: false + amount: 500 + balance: -9802.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '54' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: TRANS + reconciled: false + amount: -250 + balance: -10052.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '58' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -10002.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '50' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -8804.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '85' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: '6565689' + reconciled: false + amount: -1800 + balance: -11964.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '97' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -17896.83 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1183' + accountId: '1200' + clearedOnDate: '2021-09-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 11299.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1184' + accountId: '1200' + clearedOnDate: '2021-09-15T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 10099.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1185' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 9949.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1186' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 9944.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1187' + accountId: '1200' + clearedOnDate: '2021-10-13T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 8744.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1188' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 8594.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1189' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 8588.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1190' + accountId: '1200' + clearedOnDate: '2021-11-10T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 7388.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1191' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 7238.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1192' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 7233.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1193' + accountId: '1200' + clearedOnDate: '2021-12-08T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 6033.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1194' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 5883.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1195' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 5877.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '24' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: O/Bal + reconciled: true + amount: -6511.96 + balance: -6511.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '26' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '56956' + reconciled: false + amount: 55 + balance: -6456.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '27' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656678' + reconciled: false + amount: -150 + balance: -6606.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '28' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656679' + reconciled: false + amount: -352 + balance: -6958.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '29' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656680' + reconciled: false + amount: -550 + balance: -7508.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '30' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656681' + reconciled: false + amount: -250 + balance: -7758.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '31' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656869' + reconciled: false + amount: -546 + balance: -8304.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1196' + accountId: '1200' + clearedOnDate: '2022-01-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 5715.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1197' + accountId: '1200' + clearedOnDate: '2022-01-05T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 4515.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1198' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 4365.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1199' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 4360.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '255' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: (BACS) + reconciled: false + amount: -370.71 + balance: -18267.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '256' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100001' + reconciled: false + amount: -256.36 + balance: -18523.9 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '257' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100002' + reconciled: false + amount: -25.5 + balance: -18549.4 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '258' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100003' + reconciled: false + amount: -1977.58 + balance: -20526.98 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '259' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100004' + reconciled: false + amount: -599.03 + balance: -21126.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '260' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100005' + reconciled: false + amount: -7141.98 + balance: -28267.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '261' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100006' + reconciled: false + amount: -150.96 + balance: -28418.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '262' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100007' + reconciled: false + amount: -63 + balance: -28481.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '263' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100008' + reconciled: false + amount: -35.01 + balance: -28516.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '264' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100009' + reconciled: false + amount: -1659.34 + balance: -30176.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '265' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '4353454' + reconciled: false + amount: 1432.17 + balance: -28744.13 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '266' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 2684.26 + balance: -26059.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '267' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1204.57 + balance: -24855.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '268' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1140.78 + balance: -23714.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '269' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 4372 + balance: -19342.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '270' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1946.18 + balance: -17396.34 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '271' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 11123.33 + balance: -6273.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1200' + accountId: '1200' + clearedOnDate: '2022-02-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 3160.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '300' + accountId: '1200' + clearedOnDate: '2022-02-03T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -16588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1201' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 3010.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1202' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 3004.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '276' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Credit + reconciled: false + amount: -500 + balance: -6773.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '279' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: -58.75 + balance: -6831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '280' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -1400 + balance: -8231.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '282' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -12600 + balance: -20831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '286' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: 6500 + balance: -14331.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '287' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: PAYE + reconciled: false + amount: -1256.33 + balance: -15588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '288' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Deposit + reconciled: false + amount: -500 + balance: -16088.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '314' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -16750.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '315' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -17950.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '325' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -150 + balance: -18100.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '326' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -5.55 + balance: -18105.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '328' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Returned + reconciled: false + amount: 103.4 + balance: -18002.24 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '331' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -23934.53 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '523' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 6556.33 + balance: -17378.2 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '525' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 3350.33 + balance: -14027.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '526' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: (BACS) + reconciled: false + amount: -435.14 + balance: -14463.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '529' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '12324' + reconciled: false + amount: -8561.48 + balance: -23024.49 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '532' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: VOID + reconciled: false + amount: 352.5 + balance: -22671.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '534' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: SED + reconciled: false + amount: 55 + balance: -22616.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1203' + accountId: '1200' + clearedOnDate: '2022-03-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 1804.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '821' + accountId: '1200' + clearedOnDate: '2022-03-10T00:00:00' + description: '' + reconciled: false + amount: 1908.89 + balance: -14370.08 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '820' + accountId: '1200' + clearedOnDate: '2022-03-20T00:00:00' + description: '776' + reconciled: false + amount: 9057.34 + balance: -16278.97 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '606' + accountId: '1200' + clearedOnDate: '2022-03-24T00:00:00' + description: Deposit + reconciled: false + amount: -150 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '607' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '44555' + reconciled: false + amount: 100 + balance: -22270.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '823' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '' + reconciled: false + amount: 1770.15 + balance: -12229.5 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '578' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '456' + reconciled: false + amount: -15 + balance: -22084.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '608' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: CREDIT + reconciled: false + amount: -100 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '824' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '' + reconciled: false + amount: 1025.86 + balance: -11203.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1204' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 1654.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1205' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 1649.06 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '546' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -22778.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '547' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -23978.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '548' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: -24128.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '549' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: -24134.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '555' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -24084.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '560' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 64.63 + balance: -24019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '562' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 2000 + balance: -22019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '563' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: -50 + balance: -22069.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '584' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: CREDIT + reconciled: false + amount: -70.31 + balance: -22155.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '589' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 30 + balance: -22125.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '596' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 35.01 + balance: -22090.21 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '597' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: PAYE + reconciled: false + amount: -2070.23 + balance: -24160.44 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '598' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -25163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '604' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 3000 + balance: -22163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '605' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: '225' + reconciled: false + amount: -56.16 + balance: -22220.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '612' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -29305.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '614' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: Sales + reconciled: false + amount: 179.2 + balance: -29126.67 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + pageNumber: 1 + pageSize: 100 + totalResults: 179 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions?page=2&pageSize=100 + Sage Business Cloud Accounting: + value: + results: + - id: 26b727ca84734e3c8e245011bd04dbf1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -5 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T11:35:39Z' + - id: 508f3fd4403e45cb903b362a4ae55344 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-10T10:51:43Z' + - id: 52e58431005e44328af44116e0433230 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.85 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:36:01Z' + - id: f3255e4b79c5427ba5b963d0e26cecfc + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:19:24Z' + - id: a00e1ce357cc4064b9cce8abe1b15110 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-04-21T00:00:00' + description: Cash Deposit Bank Transfer + reconciled: false + amount: 1000 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-04-21T21:03:25Z' + - id: a7d26740129945c3a76209020fbb7fd1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-11-25T00:00:00' + description: Bank Transfer + reconciled: false + amount: -40 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-11-25T19:35:03Z' + - id: 829f45112347471cbf99b0d9afe08113 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-02T00:00:00' + description: Made from codat api Customer Receipt + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-02T13:14:57Z' + - id: 786f769ae88a4fa898e25e2cbff43be3 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-20T00:00:00' + description: Supplier payment AD Supplier Payment + reconciled: false + amount: -2400 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-22T14:12:38Z' + - id: abb5995867c546c2b32097d515dcef2a + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-21T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 12 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-21T14:09:59Z' + - id: 943f3bd6eacc4071807d89895fe03ef4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-08-17T00:00:00' + description: Ref5565 Other Receipt + reconciled: false + amount: 50 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-08-17T11:58:37Z' + - id: 039e6bb20b6e44d690601e4dd04a5b21 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-22T00:00:00' + description: Note 1 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-22T14:22:57Z' + - id: 1a62f54358e74ba4a71dd733f2b08ba4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-27T00:00:00' + description: Note 2 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-27T14:04:05Z' + - id: a79ebcf0710d415baad6b588eb28307b + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-12-01T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 33 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-12-01T13:03:00Z' + - id: 4b691b78b6cd43c9a64d75aeb29e4d11 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T08:51:52Z' + - id: 7b1f2f55f39042838d5f7226aa92386f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -1415 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:15:26Z' + - id: 87eca750292b4cfea216e13bb22923c6 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:01:47Z' + - id: a48474f83d214637a700e76e24446086 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:10:42Z' + - id: cc1fc960e05c40c1968314efe1175b9f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: string Customer Receipt + reconciled: false + amount: 69 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:20:09Z' + - id: e600eb7549b74d96bdca18b9cc60f39d + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: Customer Receipt + reconciled: false + amount: 60 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:12:03Z' + pageNumber: 1 + pageSize: 100 + totalResults: 19 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + Xero: + value: + results: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2021-12-20T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -3136.22 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5703.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: INV0010 + counterparty: MADDOX PUBLISHING GP + reconciled: true + amount: 4200 + balance: -6203.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -10403.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-19T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -95.5 + balance: -5798.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-19T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5298.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -97 + balance: -5395.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-19T00:00:00' + description: INV-0003 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -4895.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -92 + balance: -4987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: INV-0004 + counterparty: Ridgeway University + reconciled: true + amount: 1000 + balance: -3987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -89 + balance: -4076.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-19T00:00:00' + description: INV-005 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3576.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -91 + balance: -3667.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-20T00:00:00' + description: INV-006 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3167.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-22T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -96.25 + balance: -3264.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-19T00:00:00' + description: INV-007 + counterparty: Ridgeway University + reconciled: true + amount: 1500 + balance: -1764.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -100.6 + balance: -1864.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-19T00:00:00' + description: INV-008 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -1364.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -105.75 + balance: -1470.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-19T00:00:00' + description: INV-009 + counterparty: Ridgeway University + reconciled: true + amount: 1200 + balance: -270.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -106.5 + balance: -377.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-20T00:00:00' + description: INV-0010 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: 122.98 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -119.08 + balance: 3.9 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-22T00:00:00' + description: Monthly a/c fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: -11.1 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: FP089876 + counterparty: FastPay + reconciled: true + amount: -3126.17 + balance: -1591.58 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: Subs DD + counterparty: Xero + reconciled: true + amount: -56.35 + balance: -89.16 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '0015' + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 1534.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0014 + counterparty: Port & Philip Freight + reconciled: true + amount: 541.25 + balance: 993.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '' + counterparty: Office Supplies Company + reconciled: true + amount: -21.71 + balance: -32.81 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0013 + counterparty: Young Brothers + reconciled: true + amount: 541.25 + balance: 452.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-24T00:00:00' + description: INV0012 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: -1050.33 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + counterparty: Woolworths Oaktown + reconciled: true + amount: -65.2 + balance: -1115.53 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-02T00:00:00' + description: '' + counterparty: Berry Brew Cafe + reconciled: true + amount: -15.6 + balance: -1131.13 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-09T00:00:00' + description: AR-0019 + counterparty: Bank West + reconciled: true + amount: 1500 + balance: 368.87 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-11T00:00:00' + description: CHQ 6543-000409 + counterparty: Melrose Parking Services + reconciled: true + amount: -148.5 + balance: 220.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-16T00:00:00' + description: '' + counterparty: Espresso 31 Ltd + reconciled: true + amount: -16 + balance: 204.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-19T00:00:00' + description: '' + counterparty: Brunswick Flower Suppliers T/A Brunswick Petals + reconciled: true + amount: -50 + balance: 154.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: AR-0011 + counterparty: Ridgeway University + reconciled: true + amount: 2500 + balance: 2583.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + counterparty: Mobil + reconciled: true + amount: -70.8 + balance: 83.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: PC Complete + reconciled: true + amount: -1463.88 + balance: 1449.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: AR-0018 + counterparty: City Agency + reconciled: true + amount: 329.8 + balance: 2913.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: Bank Fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: 1434.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 253.24 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-29T00:00:00' + description: FP101897 + counterparty: FastPay + reconciled: false + amount: -1223.91 + balance: -970.67 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Net Connect + reconciled: true + amount: -98.32 + balance: -1177.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Power Direct + reconciled: true + amount: -108.6 + balance: -1079.27 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: AR-0020 + counterparty: Ridgeway University + reconciled: true + amount: 6187.5 + balance: 5009.91 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 3828.66 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Swantston Security + reconciled: true + amount: -59.54 + balance: 3769.12 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-21T00:00:00' + description: '' + counterparty: Xero + reconciled: true + amount: -56.35 + balance: 3712.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-22T00:00:00' + description: INV0022 + counterparty: Petrie McLoud + reconciled: true + amount: 1407.25 + balance: 5120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-23T00:00:00' + description: '0024' + counterparty: Boom FM + reconciled: true + amount: 1000 + balance: 6120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-24T00:00:00' + description: CHQ 6543-000410 + counterparty: Melrose Parking + reconciled: true + amount: -148.5 + balance: 5971.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-25T00:00:00' + description: 0027-Part + counterparty: DIISR + reconciled: true + amount: 579.37 + balance: 6550.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: Inv 0029 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: 7092.14 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV0032 + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 8715.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: '0030' + counterparty: Young Brothers Transport + reconciled: true + amount: 541.25 + balance: 7633.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV-0031 + counterparty: Port & Philip Freight Limited + reconciled: true + amount: 541.25 + balance: 8174.64 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-27T00:00:00' + description: Eft + counterparty: Woolworths Oaktown + reconciled: true + amount: -34.1 + balance: 8681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-28T00:00:00' + description: 033-Full + counterparty: DIISR + reconciled: true + amount: 250 + balance: 8931.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-30T00:00:00' + description: Eft + counterparty: Office Supplies Company + reconciled: true + amount: -49.2 + balance: 8882.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + counterparty: Berry Brew + reconciled: true + amount: -22 + balance: 8860.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-01T00:00:00' + description: CHQ 6543-000411 + counterparty: 24 Locks + reconciled: true + amount: -69.5 + balance: 8791.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-02T00:00:00' + description: 08-4123 + counterparty: Hoyt Productions Ltd + reconciled: true + amount: -5953.75 + balance: 2837.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-03T00:00:00' + description: '' + counterparty: Carlton Functions + reconciled: true + amount: -1500 + balance: 1337.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-06T00:00:00' + description: Exps + counterparty: O.Greenville + reconciled: true + amount: -29.5 + balance: 1307.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: Rent + counterparty: Truxton Property Management + reconciled: false + amount: -1181.25 + balance: 6314.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: INV-0035 + counterparty: Ridgeway University + reconciled: false + amount: 6187.5 + balance: 7495.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0017-Part + counterparty: City Limousines + reconciled: false + amount: 100 + balance: 1914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: DEPOSIT ADV + counterparty: Jakaranda Maple Systems + reconciled: false + amount: 2000 + balance: 3914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0195 0210 + counterparty: SMART Agency + reconciled: false + amount: -4500 + balance: 1814.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-09T00:00:00' + description: Eft + counterparty: Cooper Street Bakery + reconciled: false + amount: -15.75 + balance: 3898.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-10T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 3882.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Swanston Security + reconciled: false + amount: -59.55 + balance: 3811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Cooper Street Bakery + reconciled: false + amount: -11.9 + balance: 3870.94 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Whitcoulls + reconciled: false + amount: -29.8 + balance: 4769.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1000 + balance: 4811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4799.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4757.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Sub 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: -49.9 + balance: 4588.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Reg 8018922 + counterparty: ACL Conferences + reconciled: false + amount: -85 + balance: 4672.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: New World + reconciled: false + amount: -34.6 + balance: 4637.99 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: Sublet RM2031 + counterparty: Majestic Contracting + reconciled: false + amount: 450 + balance: 6526.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4576.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1500 + balance: 6076.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6499.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: CR 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: 35 + balance: 6534.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -14.3 + balance: 6511.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 200 + balance: 6712.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -10.5 + balance: 6512.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: Fee + counterparty: Ridgeway Banking Corporation + reconciled: false + amount: -15 + balance: 6697.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 6681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6522.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + pageNumber: 1 + pageSize: 100 + totalResults: 93 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + Zoho Books: + value: + results: + - id: 104957000000060010-104957000000070175 + accountId: '104957000000060010' + clearedOnDate: '2020-02-06T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000060014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-12T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Dep + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000067014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-14T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070035 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 11980 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070055 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070097 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 10789.21 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000097011 + accountId: '104957000000060010' + clearedOnDate: '2020-02-26T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099013 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: -72 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099053 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000137017 + accountId: '104957000000060010' + clearedOnDate: '2020-05-19T00:00:00' + description: '' + reconciled: false + amount: 9000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336002 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336020 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: 1.79 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001706009 + accountId: '104957000000060010' + clearedOnDate: '2021-04-12T00:00:00' + description: '' + reconciled: false + amount: 200 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001469026 + accountId: '104957000000060010' + clearedOnDate: '2022-05-12T00:00:00' + description: '' + reconciled: false + amount: -50 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480001 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: 18.98 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480045 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001633002 + accountId: '104957000000060010' + clearedOnDate: '2022-07-27T00:00:00' + description: '' + reconciled: false + amount: 26 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001652007 + accountId: '104957000000060010' + clearedOnDate: '2022-08-08T00:00:00' + description: '' + reconciled: false + amount: 11.75 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689069 + accountId: '104957000000060010' + clearedOnDate: '2022-08-24T00:00:00' + description: '' + reconciled: false + amount: -2.89 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689125 + accountId: '104957000000060010' + clearedOnDate: '2022-08-25T00:00:00' + description: '' + reconciled: false + amount: 3.6 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + pageNumber: 1 + pageSize: 100 + totalResults: 20 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedDebtor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + x-internal: true + tags: + - Accounts receivable + summary: Aged debtors report available + description: Indicates whether the aged debtors report is available for the company. + operationId: is-aged-debtors-report-available + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + x-speakeasy-name-override: is-aged-debtors-available + x-speakeasy-group: accounts-receivable.reports + '/companies/{companyId}/reports/agedDebtor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged debtors report + description: Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. + operationId: get-accounting-aged-debtors-report + x-speakeasy-name-override: get-aged-debtors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedDebtorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.4959955Z' + reportDate: '2023-05-02T16:05:21.4459444Z' + data: + - customerId: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3367.71 + details: + - name: CreditNotes + amount: -3367.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4299.26 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -4299.26 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 981d56a7-cf63-4ed2-b8db-2eba2c0aeb5a + customerName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14959.84 + details: + - name: CreditNotes + amount: -14959.84 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 773.94 + details: + - name: Invoices + amount: 773.94 + - customerId: d3739e0f-5a70-465b-9dfe-deb8efac0cd3 + customerName: Damien Schneider + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2817.59 + details: + - name: CreditNotes + amount: -2817.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 10652b76-2a9a-43ba-a892-fb4f369fe1ef + customerName: Franco Labadie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1541.52 + details: + - name: CreditNotes + amount: -1541.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 03b7f9fd-40e0-4c71-9f93-58e867233bcb + customerName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14312.59 + details: + - name: CreditNotes + amount: -14312.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 158.76 + details: + - name: Invoices + amount: 158.76 + - customerId: bbea9634-7a60-4c3f-97cd-70e481ec2cce + customerName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -32818.36 + details: + - name: CreditNotes + amount: -32818.36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 431.71 + details: + - name: Invoices + amount: 431.71 + - customerId: d65ac505-072c-49ec-be3c-3cb74228966d + customerName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9766.18 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -9766.18 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1273.16 + details: + - name: Invoices + amount: 1273.16 + - customerId: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + customerName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2595.66 + details: + - name: CreditNotes + amount: -2595.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1397.98 + details: + - name: Invoices + amount: 1397.98 + - customerId: f67eab14-12f1-432f-af73-81ebf6ec8ddc + customerName: Neoma Kreiger + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3047.62 + details: + - name: CreditNotes + amount: -3047.62 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 2d6a5c2d-80dc-4aac-8909-ddfb3cb24437 + customerName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -225.44 + details: + - name: CreditNotes + amount: -225.44 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 976a2402-0908-46d9-9121-a93005d29c01 + customerName: Norbert Tillman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -537.61 + details: + - name: CreditNotes + amount: -537.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 453ddfc0-49ce-4f66-a815-dae734be885c + customerName: Ralph Wilderman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2538.49 + details: + - name: CreditNotes + amount: -2538.49 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 51f03576-f6b0-40d5-9fba-81a490411c03 + customerName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4403.5 + details: + - name: CreditNotes + amount: -4403.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3477.81 + details: + - name: Invoices + amount: 3477.81 + - customerId: 84539fde-118f-48ed-978d-0aa50c7ec223 + customerName: Rodger Feest + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1456.66 + details: + - name: CreditNotes + amount: -1456.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7366.21 + details: + - name: Invoices + amount: 7366.21 + - customerId: dc75136b-b504-49c5-be35-04e1d2771e1e + customerName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80.97 + details: + - name: CreditNotes + amount: -80.97 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:20.8918448Z' + reportDate: '2023-05-02T16:05:20.8411594Z' + data: + - customerId: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + customerName: Abdi Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80 + details: + - name: CreditNotes + amount: -80 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -257.28 + details: + - name: Payments + amount: -300 + - name: Invoices + amount: 42.72 + - customerId: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Adatum Corporation + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1558.56 + details: + - name: CreditNotes + amount: -1558.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33200.76 + details: + - name: Invoices + amount: 34782.32 + - name: Payments + amount: -1581.56 + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8554.46 + details: + - name: Invoices + amount: 8554.46 + - customerId: ba1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Alpine Ski House + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7503.08 + details: + - name: Invoices + amount: 7503.08 + - customerId: f5860a8e-4b5a-eb11-89fa-00224800af18 + customerName: CustomerQA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 349.68 + details: + - name: Invoices + amount: 349.68 + - customerId: feef29a2-1d59-ed11-8c36-002248c5e6c0 + customerName: DP Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 332.2 + details: + - name: Invoices + amount: 427.2 + - name: Payments + amount: -95 + - customerId: 264d74d4-3218-ed11-90eb-000d3a873415 + customerName: Eliana + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -779.28 + details: + - name: CreditNotes + amount: -779.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1905 + details: + - name: Invoices + amount: 1905 + - customerId: 99faf6fb-5209-eb11-bbf6-0022481ad2e8 + customerName: QA Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4923.48 + details: + - name: Invoices + amount: 4923.48 + - customerId: bc1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Relecloud + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10559.04 + details: + - name: Invoices + amount: 10559.04 + - customerId: b81217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: School of Fine Art + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33438.88 + details: + - name: Invoices + amount: 34811.2 + - name: Payments + amount: -1372.32 + - customerId: dc3f4f1b-3c54-ed11-9470-002248c5e18c + customerName: Test no payment terms + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: 9e55a119-064e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 126 + details: + - name: Invoices + amount: 126 + - customerId: b30ca600-074e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116 + details: + - name: Invoices + amount: 116 + - customerId: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Trey Researches + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24 + details: + - name: CreditNotes + amount: -24 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2663.38 + details: + - name: Payments + amount: 10 + - name: Invoices + amount: 2653.38 + - customerId: d93ceb37-b805-ec11-86bc-0022481a45c2 + customerName: Vegan Bakeshop + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -18.67 + details: + - name: Payments + amount: -18.67 + FreshBooks: + value: + generated: '2023-05-02T16:05:20.6173310Z' + reportDate: '2023-05-02T16:05:20.5039554Z' + data: + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1 + details: + - name: Payments + amount: -1 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -500 + details: + - name: Payments + amount: -500 + - name: Invoices + amount: 0 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Payments + amount: -100 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -49 + details: + - name: Payments + amount: -49 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: '602174' + customerName: ab1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 222.71 + details: + - name: Invoices + amount: 222.71 + - currency: AED + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - customerId: '511657' + customerName: Bob's Stationary + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2060.2 + details: + - name: Payments + amount: -2083.83 + - name: Invoices + amount: 23.63 + - customerId: '581145' + customerName: CanadaCo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -132.15 + details: + - name: Payments + amount: -160.9 + - name: Invoices + amount: 28.75 + - currency: CNY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.88 + details: + - name: Invoices + amount: 2.88 + - customerId: '578409' + customerName: company1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1031.45 + details: + - name: Invoices + amount: 144 + - name: Payments + amount: -1175.45 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100.29 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100.29 + - customerId: '669531' + customerName: P + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24.98 + details: + - name: Invoices + amount: 24.98 + - customerId: '515655' + customerName: Parent company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2898.25 + details: + - name: Payments + amount: -2898.25 + - name: Invoices + amount: 0 + - customerId: '511669' + customerName: Pens International + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 516.3 + details: + - name: Payments + amount: 0 + - name: Invoices + amount: 516.3 + - customerId: '582461' + customerName: QA Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -76 + details: + - name: Invoices + amount: 20 + - name: Payments + amount: -96 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1.15 + details: + - name: Payments + amount: -1.15 + - customerId: '511661' + customerName: Sarah's Office Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - customerId: '572047' + customerName: SRS Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 141.25 + details: + - name: Invoices + amount: 141.25 + - customerId: '536295' + customerName: Test company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -144.46 + details: + - name: Invoices + amount: 7.64 + - name: Payments + amount: -152.1 + - customerId: '512927' + customerName: Wood Turnerss + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48442.07 + details: + - name: Invoices + amount: 51089.28 + - name: Payments + amount: -2647.21 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - currency: CAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.28 + details: + - name: Invoices + amount: 1186.28 + - name: Payments + amount: -994 + KashFlow: + value: + generated: '2023-05-02T16:05:20.3727270Z' + reportDate: '2023-05-02T16:05:20.3123550Z' + data: + - customerId: '88459410' + customerName: Diogo Sousa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 482.57 + details: + - name: Invoices + amount: 482.57 + - customerId: '86810130' + customerName: Maria Gomez + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -216 + details: + - name: Invoices + amount: -216 + - customerId: '86832299' + customerName: Mr French Person + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - customerId: '69946501' + customerName: Peter Lord + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3 + details: + - name: Invoices + amount: 3 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46 + details: + - name: CreditNotes + amount: -46 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55661.49 + details: + - name: Invoices + amount: 55911.49 + - name: Payments + amount: -250 + - customerId: '88353693' + customerName: Test Customer updated + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4771.03 + details: + - name: Invoices + amount: 4771.03 + - customerId: '69952389' + customerName: Things Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.42 + details: + - name: CreditNotes + amount: -42.42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6385 + details: + - name: Invoices + amount: 6385 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.0942911Z' + reportDate: '2023-05-02T16:05:20.8602315Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.0339587Z' + reportDate: '2023-05-02T16:05:19.8669114Z' + data: [] + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:19.9204890Z' + reportDate: '2023-05-02T16:05:19.8723073Z' + data: + - customerId: 1F0000-933272658 + customerName: 'Jacobsen, Doug' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 7991.52 + details: + - name: Invoices + amount: 7991.52 + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 6F0000-1071510646 + customerName: 'Morgenthaler, Jenny' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -271.53 + details: + - name: Payments + amount: -271.53 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.0640297Z' + reportDate: '2023-05-02T16:05:20.9965545Z' + data: + - customerId: '67' + customerName: Abercrombie International Group + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -837.11 + details: + - name: CreditNotes + amount: -837.11 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55512.84 + details: + - name: Invoices + amount: 55578.69 + - name: Payments + amount: -65.85 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '4' + customerName: Cathy's Consulting Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -905.8 + details: + - name: Invoices + amount: 314.2 + - name: Payments + amount: -1220 + - customerId: '20' + customerName: Chadha's Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -75 + details: + - name: Payments + amount: -75 + - customerId: '7' + customerName: Clement's Cleaners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24 + details: + - name: Invoices + amount: 24 + - customerId: '301' + customerName: Codat Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -650.27 + details: + - name: Invoices + amount: 15 + - name: CreditNotes + amount: -469.52 + - name: Payments + amount: -195.75 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 266.49 + details: + - name: Invoices + amount: 210.01 + - name: Payments + amount: 56.48 + - customerId: '305' + customerName: Codat Customer (USD) + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.5 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: 121.5 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '136' + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.37 + details: + - name: Payments + amount: 13.37 + - customerId: '218' + customerName: Diego Trantow + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11.65 + details: + - name: Payments + amount: 11.65 + - customerId: '8' + customerName: Ecker Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2273 + details: + - name: Invoices + amount: 2273 + - customerId: '59' + customerName: Ecker Holiday event + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3206779 + details: + - name: Invoices + amount: 3206779 + - customerId: '13' + customerName: Himateja Madala + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100 + - customerId: '11' + customerName: Ho Engineering Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: '114' + customerName: huw default not included + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116.4 + details: + - name: Invoices + amount: 116.4 + - customerId: '117' + customerName: Huw's Test Push customer2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -521.4 + details: + - name: CreditNotes + amount: -521.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1120.6 + details: + - name: Invoices + amount: 1232.2 + - name: Payments + amount: -111.6 + - customerId: '306' + customerName: J Codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.1 + details: + - name: Invoices + amount: 176.1 + - name: Payments + amount: -144 + - customerId: '15' + customerName: Jen Zaccarella + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4800 + details: + - name: Invoices + amount: 4800 + - customerId: '307' + customerName: Jo Codat 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 112.6 + details: + - name: Invoices + amount: 143.96 + - name: Payments + amount: 58.14 + - name: CreditNotes + amount: -89.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '119' + customerName: John Smith 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 160 + details: + - name: Invoices + amount: 160 + - customerId: '16' + customerName: Jordan Burgess + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1098 + details: + - name: CreditNotes + amount: -1098 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -60 + - customerId: '83' + customerName: Kay's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8508.37 + details: + - name: Invoices + amount: 8717.33 + - name: Payments + amount: -208.96 + - customerId: '1' + customerName: Ko International Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3586.2 + details: + - name: CreditNotes + amount: -3586.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11291.4 + details: + - name: Invoices + amount: 11474.05 + - name: Payments + amount: -182.65 + - customerId: '91' + customerName: Mr Huw Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2311.27 + details: + - name: CreditNotes + amount: -2311.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2292.91 + details: + - name: Invoices + amount: 2290.91 + - name: Payments + amount: 2 + - customerId: '55' + customerName: Oxon Insurance - Holiday Party + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10800 + details: + - name: Payments + amount: -10800 + - customerId: '70' + customerName: Project X + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50 + details: + - name: Invoices + amount: 50 + - customerId: '281' + customerName: Renee O'Connell + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12.75 + details: + - name: Payments + amount: 12.75 + - customerId: '118' + customerName: RSP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Payments + amount: 100 + - customerId: '76' + customerName: TestPushCustomer5 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1320 + details: + - name: Invoices + amount: 1320 + - customerId: '77' + customerName: TestPushCustomer6 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1848 + details: + - name: Invoices + amount: 1848 + - customerId: '79' + customerName: TestPushCustomer7 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -25 + details: + - name: Payments + amount: -25 + - customerId: '84' + customerName: Vegan Cake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -86.4 + details: + - name: CreditNotes + amount: -116.4 + - name: Payments + amount: 30 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -206460.15 + details: + - name: Invoices + amount: 5145.29 + - name: Payments + amount: -211605.44 + - customerId: '60' + customerName: Whitehead - Employee celebration + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1100 + details: + - name: CreditNotes + amount: -1100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '5' + customerName: Whitehead and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 754.4 + details: + - name: Invoices + amount: 754.4 + - customerId: '3' + customerName: Yeung's Architects + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -600 + details: + - name: CreditNotes + amount: -600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 20035.25 + details: + - name: Invoices + amount: 20604.49 + - name: Payments + amount: -569.24 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.5553019Z' + reportDate: '2023-05-02T16:05:20.4958267Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -378 + details: + - name: CreditNotes + amount: -378 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4504.07 + details: + - name: Invoices + amount: 4505.07 + - name: Payments + amount: -1 + - customerId: A1D002 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -66 + details: + - name: CreditNotes + amount: -66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 540 + details: + - name: Invoices + amount: 540 + - customerId: A1D003 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24.71 + details: + - name: CreditNotes + amount: -24.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 16606.32 + details: + - name: Invoices + amount: 16606.32 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -177.14 + details: + - name: CreditNotes + amount: -177.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4345.3 + details: + - name: Invoices + amount: 4845.3 + - name: Payments + amount: -500 + - customerId: USA1 + customerName: American Sales + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.16 + details: + - name: CreditNotes + amount: -103.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4284.77 + details: + - name: Invoices + amount: 4309.77 + - name: Payments + amount: -25 + - customerId: BRO001 + customerName: Bronson Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 786.48 + details: + - name: Invoices + amount: 852 + - name: Payments + amount: -65.52 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2274.62 + details: + - name: Invoices + amount: 2374.62 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 324.5 + details: + - name: Invoices + amount: 324.5 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4571.04 + details: + - name: Invoices + amount: 4571.04 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11260.26 + details: + - name: Invoices + amount: 11260.26 + - customerId: BRI001 + customerName: Fred Briant + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 536.67 + details: + - name: Invoices + amount: 656.67 + - name: Payments + amount: -120 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.09 + details: + - name: Invoices + amount: 4149.09 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2082.96 + details: + - name: Invoices + amount: 2082.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1228.34 + details: + - name: Invoices + amount: 1228.34 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9254.03 + details: + - name: Invoices + amount: 9254.03 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6927.26 + details: + - name: Invoices + amount: 6927.26 + - customerId: 1A2B3C + customerName: Maria Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 69.12 + details: + - name: Invoices + amount: 69.12 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3597.16 + details: + - name: Invoices + amount: 3597.16 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5644.12 + details: + - name: Invoices + amount: 6644.12 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 392.67 + details: + - name: Invoices + amount: 1767.67 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -168 + details: + - name: CreditNotes + amount: -168 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2106.84 + details: + - name: Invoices + amount: 2106.84 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 546.12 + details: + - name: Invoices + amount: 1413.9 + - name: Payments + amount: -867.78 + - customerId: RSP001 + customerName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -29210 + details: + - name: CreditNotes + amount: -29210 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 623907.28 + details: + - name: Invoices + amount: 624053.94 + - name: Payments + amount: -146.66 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4550.2 + details: + - name: Invoices + amount: 4550.2 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: '0001' + customerName: Test Customer01 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -366.71 + details: + - name: CreditNotes + amount: -366.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900.22 + details: + - name: Invoices + amount: 913.38 + - name: Payments + amount: -13.16 + - customerId: TESTSUPP + customerName: Test supplier for testing purposes 1234567891234567891234567 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 149.61 + details: + - name: Invoices + amount: 149.61 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7148.07 + details: + - name: Invoices + amount: 7148.07 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.66 + details: + - name: Invoices + amount: 2041.66 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:19.8072734Z' + reportDate: '2023-05-02T16:05:19.7472225Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.37 + details: + - name: Invoices + amount: -5.37 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2454.97 + details: + - name: Invoices + amount: 2454.97 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4309.77 + details: + - name: Invoices + amount: 4309.77 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2066.61 + details: + - name: Invoices + amount: 2166.61 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.01 + details: + - name: Invoices + amount: -0.01 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2749.02 + details: + - name: Invoices + amount: 2749.02 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11256.18 + details: + - name: Invoices + amount: 11256.18 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.08 + details: + - name: Invoices + amount: 4149.08 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1965.96 + details: + - name: Invoices + amount: 1965.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 977.09 + details: + - name: Invoices + amount: 977.09 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7398.33 + details: + - name: Invoices + amount: 7398.33 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6916.46 + details: + - name: Invoices + amount: 6916.46 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3525.26 + details: + - name: Invoices + amount: 3525.26 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2307.84 + details: + - name: Invoices + amount: 3307.84 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 370.27 + details: + - name: Invoices + amount: 1745.27 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2115.77 + details: + - name: Invoices + amount: 2115.77 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 268.93 + details: + - name: Invoices + amount: 1136.71 + - name: Payments + amount: -867.78 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4530.98 + details: + - name: Invoices + amount: 4530.98 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE002 + customerName: Steven Stephenson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8.35 + details: + - name: Invoices + amount: 8.35 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7305.77 + details: + - name: Invoices + amount: 7305.77 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.64 + details: + - name: Invoices + amount: 2041.64 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:20.9416221Z' + reportDate: '2023-05-02T16:05:20.7435694Z' + data: + - customerId: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: CreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1471 + details: + - name: Invoices + amount: 1891 + - name: Payments + amount: -420 + - customerId: 860dd9f1ad9346ba85117aedfa19cc72 + customerName: 100 test name DS + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1065 + details: + - name: Invoices + amount: 1080 + - name: Payments + amount: -15 + - customerId: 395d26ee8ab44f8b861b468caf63b00d + customerName: 222 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: CreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2443.8 + details: + - name: Invoices + amount: 2759.8 + - name: Payments + amount: -316 + - customerId: 013cf04960924a0da800f019369c3262 + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.66 + details: + - name: Invoices + amount: 9.34 + - name: Payments + amount: -10 + - customerId: 4ba77efb904e4380accc242b1526ac2c + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65 + details: + - name: Invoices + amount: 65 + - customerId: 18e45991fe6440ad8e8b5ecf9a2e7e09 + customerName: 444 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -50 + - customerId: 23ca7ffaa2b54360937531dde804c9aa + customerName: aaa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -22 + details: + - name: CreditNotes + amount: -22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -62 + details: + - name: Invoices + amount: 7 + - name: Payments + amount: -69 + - customerId: 2b93da6ce4af4dc99520eafd28768457 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 288 + details: + - name: Invoices + amount: 288 + - customerId: 460af92dd82a4a61b6ce1d18245789b3 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: b8bd7e0dfdd64d39abaaf2dcd1c48b49 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -119.99 + details: + - name: CreditNotes + amount: -119.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: aa37b59417024d2494f01ba23d92a2ef + customerName: Abe The Engineer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1562 + details: + - name: CreditNotes + amount: -1562 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1337 + details: + - name: Invoices + amount: 1362 + - name: Payments + amount: -25 + - customerId: df65eaa6789111e8aaa5027d54329956 + customerName: Baguettes Ltd + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -844.99 + details: + - name: CreditNotes + amount: -844.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 616726.02 + details: + - name: Invoices + amount: 617888.74 + - name: Payments + amount: -1162.72 + - customerId: 2916114b3b6942a7b08f1bcc971f5bf9 + customerName: c.taylor@codat.io + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Invoices + amount: 1.2 + - customerId: 0556b365ef4e42068fff775f847c0330 + customerName: Customer 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: Payments + amount: -701 + - customerId: 145dee01b49c4359a052682f234007e3 + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: 76f656dfbafa4cec823f1e2e43ea1a8e + customerName: Customer Test 59 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: a11e6776ca9a4e16af3425982de25a22 + customerName: Debs Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5279.2 + details: + - name: Invoices + amount: 5279.2 + - customerId: cc80e0fb747e4ddaab743d778d04ec4a + customerName: Debs US Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15111 + details: + - name: Invoices + amount: 15111 + - customerId: adb9cae8b34e446da3d53305b299168b + customerName: Fo Shizzle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: cc745370213545f6bd4129a7502f19fb + customerName: Grace Lo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1150 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -1150 + - customerId: 3b17c5ae9caf4b88a4a9e33a83fa321d + customerName: Hello + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Invoices + amount: 12 + - customerId: 979c5156ea0e45d9a9ea7b9d54775138 + customerName: J Customer FR + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -52795 + details: + - name: CreditNotes + amount: -52795 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 134045 + details: + - name: Invoices + amount: 134045 + - customerId: 99d52ca7060341a698a664d1737663c5 + customerName: J Customer UK + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -265 + details: + - name: CreditNotes + amount: -265 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15 + details: + - name: Invoices + amount: 30 + - name: Payments + amount: -15 + - customerId: f40870d5b704407481be14f780122d4f + customerName: J Customer US + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -161570 + details: + - name: CreditNotes + amount: -161570 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 181372 + details: + - name: Invoices + amount: 181372 + - customerId: 50a66e9756d2416d946419948bcf3631 + customerName: J Customer ZA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 0328dd6b109a4a6cbcb3d1a73f1d541b + customerName: James Arroyo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -719 + details: + - name: Invoices + amount: 178 + - name: Payments + amount: -897 + - customerId: bca2a47d7b4549c79b0c092d26b6661c + customerName: Jay Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25.01 + details: + - name: Invoices + amount: 25.01 + - customerId: 6477be6d012b4d48b4c160c098645c1c + customerName: Jo's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -37.8 + details: + - name: CreditNotes + amount: -37.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22.25 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -25.75 + - customerId: 097305a078ba473c884d2519ab290e57 + customerName: John QuickEntry Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: eac978a7622e4ef8b8d3af661f0cfdd3 + customerName: John Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Invoices + amount: 200 + - customerId: 3cc3148bbd8111e8bad90617b3da4b8a + customerName: John's Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1081.2 + details: + - name: CreditNotes + amount: -1081.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3379 + details: + - name: Invoices + amount: 3479 + - name: Payments + amount: -100 + - customerId: f66deccde15843ef80a82daad887146b + customerName: Kiran testing 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 6e921696a21a45c891ff4716a18e7649 + customerName: M Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900 + details: + - name: Invoices + amount: 900 + - customerId: bbb0582a0d054f5db268e570b50b4d6c + customerName: Mark Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 40 + details: + - name: Invoices + amount: 40 + - customerId: 440ba2199c07426a93e8edc1beb09791 + customerName: Matt Ager test EUR customer + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -8159.78 + details: + - name: CreditNotes + amount: -8159.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6016.67 + details: + - name: Invoices + amount: 6022.98 + - name: Payments + amount: -6.31 + - customerId: d430ed86b05645d7af0a630dae5d11d2 + customerName: Matthew Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 240 + details: + - name: Invoices + amount: 240 + - customerId: 9e8c3d82a2164ad29e29ab3a09ddf382 + customerName: Morv Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: fbdd38adb5b4441ebb200b83700d7ea5 + customerName: My Shop Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -384 + details: + - name: CreditNotes + amount: -384 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 398 + details: + - name: Invoices + amount: 398 + - customerId: 4b4cc40d998f47c3bec92fc088dcf327 + customerName: Nicoletta Carchia + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 90 + details: + - name: Invoices + amount: 90 + - customerId: ed070b1768bb4dd295e2a544a74c8ec0 + customerName: Paige Burlingham + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: CreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 84709d3f01a4462eb7f1527718f525f4 + customerName: SageOneCustomer.BusinessName + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1085 + details: + - name: CreditNotes + amount: -1085 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 90c438274d0b43759407da704394c104 + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.2 + details: + - name: CreditNotes + amount: -16.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1137.2 + details: + - name: Invoices + amount: 1137.2 + - customerId: 762e6895c1ff43f988f35fb507e20dd9 + customerName: Test Custiomer 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -615 + details: + - name: CreditNotes + amount: -615 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2178.25 + details: + - name: Invoices + amount: 2178.25 + - customerId: 7b9c18af4b66454b9f7e9409eb7da123 + customerName: Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Invoices + amount: 1200 + - customerId: 4ccf5c5fa14046ecb591e0620d87ea2e + customerName: Test Customer 3 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: CreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 499971 + details: + - name: Invoices + amount: 499971 + - customerId: f4ff85ba33dd11e797950a57719b2edb + customerName: Widgets Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23206.12 + details: + - name: CreditNotes + amount: -23206.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 733824.64 + details: + - name: Invoices + amount: 739536.49 + - name: Payments + amount: -5711.85 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.6557479Z' + reportDate: '2023-05-02T16:05:22.6081858Z' + data: + - customerId: '6' + customerName: AG Insurance + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 180 + details: + - name: Invoices + amount: 180 + - customerId: '531' + customerName: Shoprite + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: Payments + amount: -150 + Xero: + value: + generated: '2023-05-02T16:05:20.0730291Z' + reportDate: '2023-05-02T16:05:20.0102278Z' + data: + - customerId: 305ca5cf-497d-4fee-a161-cdb30e6be989 + customerName: Basket Case + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 914.55 + details: + - name: Invoices + amount: 914.55 + - customerId: 362819c9-f285-4d09-ac95-26327863adac + customerName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3434 + details: + - name: Invoices + amount: 3434 + - customerId: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + customerName: Boom FM + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1623.75 + details: + - name: Invoices + amount: 1623.75 + - customerId: c523e12f-8b74-4d3a-bbd8-32d7a2f598b4 + customerName: City Limousines + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1169.95 + details: + - name: Invoices + amount: 1169.95 + - customerId: 1262c350-fe0f-40ec-aeff-41c95b4a45af + customerName: DIISR - Small Business Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4470.63 + details: + - name: Invoices + amount: 4470.63 + - customerId: 94cb6d7b-5291-49f3-a0bc-fc0c01e68575 + customerName: Marine Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: 847933f0-7c35-4e5b-b884-5f9df64c8e4b + customerName: Port & Philip Freight + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2245 + details: + - name: Invoices + amount: 2245 + - customerId: a871a956-05b5-4e2a-9419-7aeb478ca647 + customerName: Ridgeway University + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6187.5 + details: + - name: Invoices + amount: 6187.5 + Zoho Books: + value: + generated: '2023-05-02T16:05:23.2078272Z' + reportDate: '2023-05-02T16:05:23.1573589Z' + data: + - customerId: '104957000000054050' + customerName: 'Doe, John' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10567 + details: + - name: CreditNotes + amount: -10567 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 38965 + details: + - name: Invoices + amount: 39865 + - name: Payments + amount: -900 + - customerId: '104957000000634160' + customerName: Dr. Jekyll + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -110 + details: + - name: CreditNotes + amount: -110 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000080010' + customerName: Max Mustermann + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -68 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -68 + - customerId: '104957000000277089' + customerName: Miss. No Contact Persons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: '104957000000054080' + customerName: Ms. Jane Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -465 + details: + - name: CreditNotes + amount: -465 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000277001' + customerName: 'Sousa, Diogo' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9001 + details: + - name: Invoices + amount: 9001 + - customerId: '104957000000037097' + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9001 + details: + - name: CreditNotes + amount: -9001 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3556.98 + details: + - name: Invoices + amount: 4501 + - name: Payments + amount: -944.02 + - customerId: '104957000001497001' + customerName: Will Westrop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Invoices + amount: 56 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: Aged creditors report available + description: Indicates whether the aged creditor report is available for the company. + operationId: is-aged-creditors-report-available + x-speakeasy-name-override: is-aged-creditors-available + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged creditors report + description: Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. + operationId: get-accounting-aged-creditors-report + x-speakeasy-name-override: get-aged-creditors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedCreditorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.7545859Z' + reportDate: '2023-05-02T16:05:21.7016767Z' + data: + - supplierId: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -78.12 + details: + - name: BillCreditNotes + amount: -78.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 375.6 + details: + - name: Bills + amount: 375.6 + - supplierId: FyUkHbZxhn + supplierName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3782.27 + details: + - name: BillCreditNotes + amount: -3782.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8556.1 + details: + - name: Bills + amount: 8556.1 + - supplierId: gxazX5hqx4 + supplierName: Bernier Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 213.19 + details: + - name: Bills + amount: 213.19 + - supplierId: ro8nWYGzlg + supplierName: Botsford - Hickle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2242.95 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2242.95 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 838.67 + details: + - name: Bills + amount: 838.67 + - supplierId: D4Q4iYwHou + supplierName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276.5 + details: + - name: BillCreditNotes + amount: -276.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46060.53 + details: + - name: Bills + amount: 46060.53 + - supplierId: 9436ead6-545e-4e8c-8444-0220047c5a38 + supplierName: Champlin LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22726.97 + details: + - name: Bills + amount: 22726.97 + - supplierId: O6jExrbN3v + supplierName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -19.39 + details: + - name: BillCreditNotes + amount: -19.39 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9d4b61a4-4ce3-4d90-8d6b-66614694dc27 + supplierName: Crona - Adams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 302.8 + details: + - name: Bills + amount: 302.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: ad8f4ee1-7a04-415f-b3dc-365d41d8d4f0 + supplierName: 'Cronin, Kunde and Tremblay' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3271.91 + details: + - name: BillCreditNotes + amount: -3271.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3479.78 + details: + - name: Bills + amount: 3479.78 + - supplierId: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16511.91 + details: + - name: BillCreditNotes + amount: -16511.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: XOPP3v2lQu + supplierName: Fisher and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 238599.9 + details: + - name: Bills + amount: 238599.9 + - supplierId: 0a7b0432-7de3-4e29-bf15-4e7ca0722384 + supplierName: Flatley - Kirlin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -113.59 + details: + - name: BillCreditNotes + amount: -113.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 910.45 + details: + - name: Bills + amount: 910.45 + - supplierId: HrGZeW4I51 + supplierName: 'Frami, Simonis and Krajcik' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2070.59 + details: + - name: BillCreditNotes + amount: -2070.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: SFmBGSHLQ3 + supplierName: Gottlieb LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.07 + details: + - name: BillCreditNotes + amount: -105.07 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: unNIu8Uyap + supplierName: Hahn and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -297.78 + details: + - name: BillCreditNotes + amount: -297.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2095.75 + details: + - name: Bills + amount: 2095.75 + - supplierId: GTGS3Sx241 + supplierName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3612.41 + details: + - name: Bills + amount: 3612.41 + - supplierId: w07H3CBm5P + supplierName: 'Hayes, Predovic and Ruecker' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -11662.51 + details: + - name: BillCreditNotes + amount: -11662.51 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 393776.18 + details: + - name: Bills + amount: 393776.18 + - supplierId: 92144542-2227-409e-8f5b-fc73260e670b + supplierName: 'Hettinger, Schmitt and Will' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 3433.54 + details: + - name: Bills + amount: 3433.54 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: rpLhEYz0ML + supplierName: Hickle - Buckridge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7484.88 + details: + - name: BillCreditNotes + amount: -7484.88 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2056eb9-649e-4808-8f96-d8ea4dac71fe + supplierName: Hodkiewicz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6627.16 + details: + - name: BillCreditNotes + amount: -6627.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18266.27 + details: + - name: Bills + amount: 18266.27 + - supplierId: s3WcvMyVdR + supplierName: Howe - Ruecker + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4042.16 + details: + - name: Bills + amount: 4042.16 + - supplierId: b60XbI9zhE + supplierName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12938.29 + details: + - name: BillCreditNotes + amount: -12938.29 + - name: Bills + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18360.8 + details: + - name: Bills + amount: 18360.8 + - supplierId: OtXKRTOcQc + supplierName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190.16 + details: + - name: Bills + amount: 190.16 + - supplierId: c02bc2f1-631d-4721-aec1-a190d63e8322 + supplierName: Jones - Zulauf + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69.05 + details: + - name: BillCreditNotes + amount: -69.05 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51357.36 + details: + - name: Bills + amount: 51357.36 + - supplierId: c02382bd-ff23-4b34-bfd7-8dce15fa7d6a + supplierName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2496.69 + details: + - name: BillCreditNotes + amount: -2496.69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1519.74 + details: + - name: Bills + amount: 1519.74 + - supplierId: d3tf43eghS + supplierName: Klocko - Keebler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12367.4 + details: + - name: Bills + amount: 12367.4 + - supplierId: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -318.71 + details: + - name: BillCreditNotes + amount: -318.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: gO8p5O3Mvy + supplierName: Lehner Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1042.8 + details: + - name: BillCreditNotes + amount: -1042.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 62229022-713f-4c64-84f2-63cf6dd11443 + supplierName: Littel - Cole + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7.5 + details: + - name: BillCreditNotes + amount: -7.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 39b32019-c5d0-4db3-ae83-f0a644e614ef + supplierName: Marvin - Schaden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1611.56 + details: + - name: BillCreditNotes + amount: -1611.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 8635b986-048f-424c-985d-912576c004d9 + supplierName: 'Mills, Bechtelar and Wintheiser' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -604.41 + details: + - name: BillCreditNotes + amount: -604.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2fb1aba-79ac-4840-95d5-6c173c9beaad + supplierName: Morissette LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55.93 + details: + - name: BillCreditNotes + amount: -55.93 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 27dc0345-aae8-4b69-a903-fed6b0a8778b + supplierName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1546.46 + details: + - name: Bills + amount: 1546.46 + - supplierId: 0d892acd-4b56-4412-80ee-381b8118637b + supplierName: Nicolas - McKenzie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -186.97 + details: + - name: BillCreditNotes + amount: -186.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5131.74 + details: + - name: Bills + amount: 5131.74 + - supplierId: cc283863-960f-42f8-8e38-1e22235e9cfc + supplierName: Nicolas Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6.41 + details: + - name: BillCreditNotes + amount: -6.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9UvJVVmPHO + supplierName: Nienow - Schroeder + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2822.41 + details: + - name: BillCreditNotes + amount: -2822.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 1346295c-2970-47a7-8a99-1f935567db02 + supplierName: Polly Crona + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3600.36 + details: + - name: Bills + amount: 3600.36 + - supplierId: 5fcb09bf-ae92-42a1-a69b-57c5f0ebedd9 + supplierName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2938.85 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2938.85 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 4253a13e-638e-4a42-9e61-665a60267a48 + supplierName: 'Robel, Ledner and Stroman' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1106.72 + details: + - name: Bills + amount: 1106.72 + - supplierId: 143ed2c5-2623-465e-a015-5ac12df75aa6 + supplierName: Schulist - Douglas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12468.22 + details: + - name: BillCreditNotes + amount: -12468.22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 39306.44 + details: + - name: Bills + amount: 39306.44 + - supplierId: d770b767-489e-455b-9d32-29c37a1b9d07 + supplierName: Schultz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -517.52 + details: + - name: BillCreditNotes + amount: -517.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 98e93284-fcaa-440c-8f86-f36e5df591da + supplierName: Simonis - Ziemann + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -597.01 + details: + - name: BillCreditNotes + amount: -597.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 87e907ed-97f8-4146-b276-fea2a10671bf + supplierName: Sporer and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -62443.6 + details: + - name: BillCreditNotes + amount: -62443.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 97682025-4e50-449f-8510-6d09d1d0f84b + supplierName: Sporer LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1104.37 + details: + - name: BillCreditNotes + amount: -1104.37 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1050.12 + details: + - name: Bills + amount: 1050.12 + - supplierId: c51351a0-b43f-48c6-8dbb-8417171bda67 + supplierName: Veum - Schiller + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1966.59 + details: + - name: BillCreditNotes + amount: -1966.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10234.97 + details: + - name: Bills + amount: 10234.97 + - supplierId: 26f6b56a-4a86-468f-a302-9d60bdc01d91 + supplierName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23450.31 + details: + - name: BillCreditNotes + amount: -23450.31 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: f589fd05-c5f8-4815-b205-0a9f3f0b3b96 + supplierName: Weber LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -681.79 + details: + - name: BillCreditNotes + amount: -681.79 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10221.45 + details: + - name: Bills + amount: 10221.45 + - supplierId: 1cc8b95c-62ec-415a-ab0e-facf7e7218bf + supplierName: 'Welch, Terry and Hermiston' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1219.54 + details: + - name: Bills + amount: 1219.54 + - supplierId: f6CgWtm1aw + supplierName: Wisoky Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 272.67 + details: + - name: Bills + amount: 272.67 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: je5ok1Cam5 + supplierName: 'Wunsch, Kerluke and West' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7238.24 + details: + - name: Bills + amount: 7238.24 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:21.1349781Z' + reportDate: '2023-05-02T16:05:21.0866594Z' + data: + - supplierId: e89328bd-485a-eb11-89fa-00224800af18 + supplierName: A QA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -526.8 + details: + - name: BillCreditNotes + amount: -526.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 120 + details: + - name: Bills + amount: 120 + - supplierId: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11904.4 + details: + - name: Bills + amount: 461.6 + - name: BillPayments + amount: -12366 + - currency: PLN + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -15 + details: + - name: BillPayments + amount: -15 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12123.81 + details: + - name: Bills + amount: 12128.81 + - name: BillPayments + amount: -5 + - supplierId: c21217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Graphic Design Institute + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7514.8 + details: + - name: Bills + amount: 7520.8 + - name: BillPayments + amount: -6 + - supplierId: 4a1b210e-b805-ec11-86bc-0022481a45c2 + supplierName: Kays Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -121 + details: + - name: BillPayments + amount: -121 + - supplierId: c61217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Nod Publishers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13156.74 + details: + - name: Bills + amount: 13156.74 + - supplierId: b864b5ae-4a5a-eb11-89fa-00224800af18 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3951 + details: + - name: Bills + amount: 3951 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.45 + details: + - name: Bills + amount: 121.45 + - supplierId: 8b4c95b4-b705-ec11-86bc-0022481a45c2 + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.27 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -5.27 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11.75 + details: + - name: BillPayments + amount: -11.75 + - supplierId: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15843.22 + details: + - name: Bills + amount: 15848.22 + - name: BillPayments + amount: -5 + Exact (Netherlands): + value: + generated: '2023-05-02T16:05:19.8312183Z' + reportDate: '2023-05-02T16:05:19.7538301Z' + data: + - supplierId: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -38.28 + details: + - name: BillCreditNotes + amount: -38.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1952.27 + details: + - name: Bills + amount: 1941.58 + - name: BillPayments + amount: 10.69 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10000 + details: + - name: BillCreditNotes + amount: -10000 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117 + details: + - name: Bills + amount: 117 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4997.25 + details: + - name: Bills + amount: 4997.25 + - supplierId: 78afea22-ee21-48c3-84d5-45b9b24768e9 + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 110 + details: + - name: Bills + amount: 108 + - name: BillPayments + amount: 2 + - supplierId: 773416a6-b196-487b-ae02-eeb273a86bcd + supplierName: Belastingdienst + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -293.14 + details: + - name: BillCreditNotes + amount: -293.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1547.08 + details: + - name: Bills + amount: 1547.08 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.17 + details: + - name: Bills + amount: 32.17 + - supplierId: 7017da1f-2d49-4601-abf3-c4e779459976 + supplierName: Bool Test + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121 + details: + - name: Bills + amount: 121 + - supplierId: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65.73 + details: + - name: BillCreditNotes + amount: -65.73 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -83351.62 + details: + - name: BillPayments + amount: -83381.63 + - name: Bills + amount: 30.01 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -8285.73 + details: + - name: BillPayments + amount: -8285.73 + - supplierId: 8cb6745b-4769-4c7a-9d92-bc688c60ca3c + supplierName: iZettle AB (Supplier) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 19.93 + details: + - name: Bills + amount: 19.93 + - supplierId: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: BillPayments + amount: 5 + - supplierId: acde3236-898e-4e68-b076-4e946defbc5f + supplierName: Matt Ager Test Supplier 1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276 + details: + - name: BillCreditNotes + amount: -276 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 75 + details: + - name: Bills + amount: 105 + - name: BillPayments + amount: -30 + - currency: RUB + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: BillPayments + amount: -10 + - supplierId: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12.1 + details: + - name: BillCreditNotes + amount: -12.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.97 + details: + - name: Bills + amount: 119.97 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7040 + details: + - name: BillCreditNotes + amount: -7040 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8800 + details: + - name: Bills + amount: 8800 + - supplierId: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.83 + details: + - name: Bills + amount: -0.83 + - supplierId: 1d2c9f47-a2fc-48e6-a967-71583d764b10 + supplierName: NLSuppliers07 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25 + details: + - name: Bills + amount: 25 + - supplierId: a1e88d58-caec-4ed6-ad1b-646ebb959c17 + supplierName: supplierrrr + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55 + details: + - name: BillCreditNotes + amount: -55 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11084 + details: + - name: Bills + amount: 11084 + - supplierId: cdcdce7b-0330-49fb-8169-0a50e0b74dcc + supplierName: Test NL sup1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.21 + details: + - name: BillPayments + amount: 13.21 + - supplierId: bad8020a-267f-41fb-9e0f-e93465ee9529 + supplierName: Test supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 718.22 + details: + - name: Bills + amount: 718.22 + - supplierId: 26bc5305-8613-43e4-ab97-522ade34cbba + supplierName: Vandana's Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 403.74 + details: + - name: Bills + amount: 403.74 + Exact (UK): + value: + generated: '2023-05-02T16:05:22.8960035Z' + reportDate: '2023-05-02T16:05:22.8283897Z' + data: + - supplierId: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 560.1 + details: + - name: Bills + amount: 660.1 + - name: BillPayments + amount: -100 + - supplierId: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -400 + details: + - name: BillCreditNotes + amount: -400 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 430 + - name: BillPayments + amount: -400 + - supplierId: 5f20075a-a28e-434d-81a6-2db0dc170e87 + supplierName: Abdi 99 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 609 + details: + - name: Bills + amount: 258 + - name: BillPayments + amount: 351 + - supplierId: 0d3f8692-4b0a-4bc3-85f2-4cb763306397 + supplierName: Ann's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3600 + details: + - name: BillCreditNotes + amount: -3600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2400 + details: + - name: Bills + amount: 2400 + - supplierId: fc62db43-a6f8-4b65-9d29-15290ec56674 + supplierName: Anna's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1717.5 + details: + - name: BillCreditNotes + amount: -1717.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2751 + details: + - name: Bills + amount: 2751 + - supplierId: cde51f36-2a06-4eac-9784-c0c967c1e1ed + supplierName: b + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6 + details: + - name: BillCreditNotes + amount: -6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 437c6631-3c5d-4351-b757-6ad4f94bd26e + supplierName: bb + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 220 + details: + - name: Bills + amount: 220 + - supplierId: fe713acb-3c98-423d-8372-68a32aae6232 + supplierName: cc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: BillPayments + amount: -60 + - supplierId: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100073.4 + details: + - name: BillCreditNotes + amount: -100073.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 374.8 + details: + - name: Bills + amount: 373.8 + - name: BillPayments + amount: 1 + - supplierId: 6a4c6a14-d5eb-4427-aae0-c544f67dff7a + supplierName: CustomerAndSupplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.05 + details: + - name: BillPayments + amount: 2.05 + - supplierId: efb5d438-7d3a-4b77-a254-2d90f76d3f22 + supplierName: dd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: 77b652bb-a363-4425-adbd-0206e2ce4639 + supplierName: e + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -72.33 + details: + - name: BillCreditNotes + amount: -72.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 133.6 + details: + - name: Bills + amount: 133.6 + - supplierId: 7c8a9143-7322-48e3-b809-88a038b8a0e0 + supplierName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.5 + details: + - name: Bills + amount: 192.5 + - supplierId: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1200 + details: + - name: BillCreditNotes + amount: -1200 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3837 + details: + - name: Bills + amount: 3837 + - supplierId: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46.8 + details: + - name: BillCreditNotes + amount: -46.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -54537.12 + details: + - name: Bills + amount: 455.73 + - name: BillPayments + amount: -54992.85 + FreeAgent: + value: + generated: '2023-05-02T16:05:23.3560058Z' + reportDate: '2023-05-02T16:05:23.3059155Z' + data: + - supplierId: '10123537' + supplierName: _Test 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 791 + details: + - name: Bills + amount: 791 + - currency: QAR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '11526230' + supplierName: '-' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6430 + details: + - name: Bills + amount: 1500 + - name: BillCreditNotes + amount: -7930 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: '9677150' + supplierName: '-' + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: '8959011' + supplierName: '1' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -134.3 + details: + - name: BillCreditNotes + amount: -134.3 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46 + details: + - name: Bills + amount: 46 + - supplierId: '6161941' + supplierName: A & J Fabtech Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2433.99 + details: + - name: BillCreditNotes + amount: -2433.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3431 + details: + - name: Bills + amount: 3431 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 400 + details: + - name: Bills + amount: 400 + - supplierId: '6161963' + supplierName: ABB Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: '9356878' + supplierName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '8984892' + supplierName: Abraham's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 77 + details: + - name: Bills + amount: 77 + - supplierId: '9273150' + supplierName: Best Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -456 + details: + - name: BillCreditNotes + amount: -456 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: '6161956' + supplierName: C Allen + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100 + details: + - name: BillCreditNotes + amount: -100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 122 + details: + - name: Bills + amount: 122 + - supplierId: '7994567' + supplierName: codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: '5730310' + supplierName: Demo Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '6162169' + supplierName: PricewaterhouseCoopers LLP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 42 + details: + - name: Bills + amount: 42 + - supplierId: '10672202' + supplierName: Random Org + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42 + details: + - name: BillCreditNotes + amount: -42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: '8989342' + supplierName: Supplier Hidden + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -500 + details: + - name: BillCreditNotes + amount: -500 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: BillPayments + amount: -150 + - supplierId: '7169654' + supplierName: The Eagle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -492 + details: + - name: BillCreditNotes + amount: -492 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3523.75 + details: + - name: Bills + amount: 3523.75 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 301 + details: + - name: Bills + amount: 301 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.5229720Z' + reportDate: '2023-05-02T16:05:21.2821865Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.3296968Z' + reportDate: '2023-05-02T16:05:20.2442587Z' + data: + - supplierId: '779' + supplierName: Test Vendor + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Bills + amount: 56 + - supplierId: '724' + supplierName: Vendor A.A.A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 579.55 + details: + - name: Bills + amount: 524 + - name: BillPayments + amount: 55.55 + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:20.3972104Z' + reportDate: '2023-05-02T16:05:20.3178060Z' + data: + - supplierId: B0000-933272656 + supplierName: Patton Hardware Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5000 + details: + - name: Bills + amount: 5000 + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.3065432Z' + reportDate: '2023-05-02T16:05:21.2488309Z' + data: + - supplierId: '129' + supplierName: Ally Johnson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 230.98 + details: + - name: Bills + amount: 276.38 + - name: BillPayments + amount: -45.4 + - supplierId: '88' + supplierName: Andrew Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16 + details: + - name: BillCreditNotes + amount: -16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 66.25 + details: + - name: BillPayments + amount: -13.75 + - name: Bills + amount: 80 + - supplierId: '53' + supplierName: Bank of AnyCity + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63 + details: + - name: Bills + amount: 63 + - supplierId: '282' + supplierName: Becky's Bakery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 490.5 + details: + - name: BillPayments + amount: -9.5 + - name: Bills + amount: 500 + - supplierId: '24' + supplierName: Brijesh Jain + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69 + details: + - name: BillCreditNotes + amount: -69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 52260 + details: + - name: Bills + amount: 52260 + - supplierId: '25' + supplierName: Brittney Hughes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 70 + details: + - name: Bills + amount: 70 + - supplierId: '26' + supplierName: Burc Gunes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33.05 + details: + - name: Bills + amount: 33.05 + - supplierId: '27' + supplierName: Cass Hayden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1450 + details: + - name: Bills + amount: 1500 + - name: BillPayments + amount: -50 + - supplierId: '51' + supplierName: City Water Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7.25 + details: + - name: Bills + amount: 24 + - name: BillPayments + amount: -16.75 + - supplierId: '297' + supplierName: Codat Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -128 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -25 + - name: BillCreditNotes + amount: -103 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -328.32 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -328.32 + - supplierId: '87' + supplierName: Costco + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -17.85 + details: + - name: BillPayments + amount: -17.85 + - supplierId: '57' + supplierName: Hall's Promo Items + agedCurrencyOutstanding: + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1041.09 + details: + - name: Bills + amount: 1041.09 + - supplierId: '92' + supplierName: Huw Thomas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25292 + details: + - name: Bills + amount: 25302 + - name: BillPayments + amount: -10 + - supplierId: '85' + supplierName: Jay's Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -446.83 + details: + - name: BillCreditNotes + amount: -446.83 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9759.68 + details: + - name: Bills + amount: 9822.46 + - name: BillPayments + amount: -62.78 + - supplierId: '34' + supplierName: Jennifer Hargreaves + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 239.01 + details: + - name: Bills + amount: 239.01 + - supplierId: '37' + supplierName: Kristina Gibson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1710 + details: + - name: BillCreditNotes + amount: -1710 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 502.38 + details: + - name: Bills + amount: 502.38 + - supplierId: '41' + supplierName: Mark Howard + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3000 + details: + - name: Bills + amount: 3000 + - supplierId: '23' + supplierName: Mr Andrew Thomas Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -21.2 + details: + - name: BillCreditNotes + amount: -21.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.09 + details: + - name: Bills + amount: 54.09 + - supplierId: '54' + supplierName: Organization of Outstanding Event Planners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 390 + details: + - name: Bills + amount: 390 + - supplierId: '47' + supplierName: Sanjeev Kak + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 21 + details: + - name: Bills + amount: 21 + - supplierId: '74' + supplierName: TestPushCustomer3 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '86' + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.76 + details: + - name: BillCreditNotes + amount: -42.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1249.3 + details: + - name: BillPayments + amount: -504.24 + - name: Bills + amount: 1753.54 + - supplierId: '58' + supplierName: Venue Rental + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 461 + details: + - name: Bills + amount: 500 + - name: BillPayments + amount: -39 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.7939148Z' + reportDate: '2023-05-02T16:05:20.7474542Z' + data: + - supplierId: CON002 + supplierName: Concept Stationery Sub A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 411.76 + details: + - name: Bills + amount: 782.56 + - name: BillPayments + amount: -370.8 + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -167.1 + details: + - name: BillCreditNotes + amount: -167.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5062.78 + details: + - name: Bills + amount: 5111.01 + - name: BillPayments + amount: -48.23 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25802.03 + details: + - name: Bills + amount: 25934.03 + - name: BillPayments + amount: -132 + - supplierId: MEA001 + supplierName: Mears Insurance + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: BillCreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1368.02 + details: + - name: Bills + amount: 1524 + - name: BillPayments + amount: -155.98 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -13.21 + details: + - name: BillCreditNotes + amount: -13.21 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1024.13 + details: + - name: Bills + amount: 1041.61 + - name: BillPayments + amount: -17.48 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.64 + details: + - name: BillCreditNotes + amount: -105.64 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 155.92 + details: + - name: Bills + amount: 155.92 + - supplierId: RSP002 + supplierName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60000 + details: + - name: Bills + amount: 60000 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1130.29 + details: + - name: Bills + amount: 1189.29 + - name: BillPayments + amount: -59 + - supplierId: STU001 + supplierName: Studio Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 562.06 + details: + - name: Bills + amount: 562.06 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2055.3 + details: + - name: Bills + amount: 2055.3 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9433.71 + details: + - name: Bills + amount: 9433.71 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 576.04 + details: + - name: Bills + amount: 1091.04 + - name: BillPayments + amount: -515 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1104.16 + details: + - name: Bills + amount: 1104.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -70.76 + details: + - name: BillCreditNotes + amount: -70.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -221.75 + details: + - name: Bills + amount: -121.75 + - name: BillPayments + amount: -100 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:20.0257207Z' + reportDate: '2023-05-02T16:05:19.9751677Z' + data: + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1644.39 + details: + - name: Bills + amount: 1644.39 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24734.12 + details: + - name: Bills + amount: 24734.12 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -0.01 + details: + - name: BillCreditNotes + amount: -0.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0.01 + details: + - name: Bills + amount: 0.01 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.63 + details: + - name: BillCreditNotes + amount: -42.63 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 72.85 + details: + - name: Bills + amount: 72.85 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 352.5 + details: + - name: Bills + amount: 352.5 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1762.5 + details: + - name: Bills + amount: 1762.5 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9164.95 + details: + - name: Bills + amount: 9164.95 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 472.24 + details: + - name: Bills + amount: 972.24 + - name: BillPayments + amount: -500 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 744.16 + details: + - name: Bills + amount: 744.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -58.76 + details: + - name: BillCreditNotes + amount: -58.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117.29 + details: + - name: Bills + amount: 117.29 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:21.3095542Z' + reportDate: '2023-05-02T16:05:21.1514485Z' + data: + - supplierId: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: BillCreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1548.84 + details: + - name: Bills + amount: 1608.84 + - name: BillPayments + amount: -60 + - supplierId: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -841570.32 + details: + - name: BillCreditNotes + amount: -841570.32 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 661901.14 + details: + - name: Bills + amount: 662062.14 + - name: BillPayments + amount: -161 + - supplierId: f82f0f59fbf44416b833562783388ee9 + supplierName: Abe's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -38.8 + details: + - name: Bills + amount: 1.2 + - name: BillPayments + amount: -40 + - supplierId: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -140.97 + details: + - name: BillCreditNotes + amount: -140.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1856307.16 + details: + - name: BillPayments + amount: -213 + - name: Bills + amount: 1856520.16 + - supplierId: b1354c4ae5db4d069acbcf49bee62215 + supplierName: Boyer Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 360000 + details: + - name: Bills + amount: 360000 + - supplierId: 46b3d6acedcb4738a9646dc512562cda + supplierName: callum + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Bills + amount: 1.2 + - supplierId: 7e7450fadbb94d09abdaf609a51d05eb + supplierName: Debs UK Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1814652 + details: + - name: Bills + amount: 1814652 + - supplierId: bf6fc20701264c899a1ba96365aa9d70 + supplierName: Eliana's + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.6 + details: + - name: BillCreditNotes + amount: -105.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 26.4 + details: + - name: Bills + amount: 26.4 + - supplierId: 30862a4b2c084a4fa2e640f9ef371e4c + supplierName: Flour Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60 + details: + - name: Bills + amount: 60 + - supplierId: 390ca10633cb4bf989961491e834b47a + supplierName: Jo Cheese + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9 + details: + - name: Bills + amount: 9 + - supplierId: b10be78d0e9340a79743c538a0b481d0 + supplierName: M7 Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65150090 + details: + - name: Bills + amount: 65150090 + - supplierId: 693d3b961e744b02a6a260f4bada75b0 + supplierName: Matt Ager Test EU Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6841.33 + details: + - name: BillCreditNotes + amount: -6841.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6841.33 + details: + - name: Bills + amount: 6841.33 + - supplierId: 1edf56c368e14a35a050b3e8336e2272 + supplierName: Mike B Commerce Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Bills + amount: 300 + - supplierId: c6d3fa5bf2634b148d0ee82b6fbb8fe3 + supplierName: my shop supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: BillCreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: cdeae2fcbe6447f698d2a59d68e4ad82 + supplierName: Nic Supp + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 2e14c8cfee3041a4a5e8a619b336f900 + supplierName: Nic Supplies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 30 + - supplierId: c41981674176495f927f46ce663d46ac + supplierName: Ninetta Ponting + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -306 + details: + - name: BillPayments + amount: -306 + - supplierId: e2dd680fed99410982673f8fc2722357 + supplierName: Supplier 70 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -70 + details: + - name: BillPayments + amount: -70 + - supplierId: 8d61f7cd3a2f4ceea26ac5bca15e10da + supplierName: Supplier 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: BillPayments + amount: -701 + - supplierId: 7a67caeb261f40259f0948785090af0b + supplierName: supplier test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12014.4 + details: + - name: Bills + amount: 12014.4 + - supplierId: d884f637bb3a4e589d640085b31ad6ee + supplierName: Tasty Treats Icecreams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -454 + details: + - name: BillCreditNotes + amount: -454 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 456 + details: + - name: Bills + amount: 456 + - supplierId: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1152.78 + details: + - name: BillCreditNotes + amount: -1152.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 14960.37 + details: + - name: Bills + amount: 15064.41 + - name: BillPayments + amount: -104.04 + - supplierId: 2541e491791c485a96cc480cfde112d6 + supplierName: Test Supplier 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: BillCreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63338524.47 + details: + - name: Bills + amount: 63338524.47 + - supplierId: 877aac191c3c40eda61115eea12641f7 + supplierName: Test Supplier 3 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3535.61 + details: + - name: BillCreditNotes + amount: -3535.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50658.58 + details: + - name: Bills + amount: 50658.58 + - supplierId: d98e7afb4ca846dfbb12ca285f95f863 + supplierName: Test Supplier 4 (US) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51872949 + details: + - name: Bills + amount: 51872949 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.9252709Z' + reportDate: '2023-05-02T16:05:22.8758390Z' + data: + - supplierId: '3' + supplierName: ADP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 487.5 + details: + - name: Bills + amount: 487.5 + - supplierId: '14' + supplierName: Kristofferson Consulting + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7200 + details: + - name: Bills + amount: 7200 + - supplierId: '7' + supplierName: Lenovo + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190 + details: + - name: Bills + amount: 190 + - supplierId: '8' + supplierName: Worldwide Commercial + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + Xero: + value: + generated: '2023-05-02T16:05:20.3006654Z' + reportDate: '2023-05-02T16:05:20.2587933Z' + data: + - supplierId: 699f0091-b127-4796-9f15-41a2f42abeb2 + supplierName: ABC Furniture + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: 362819c9-f285-4d09-ac95-26327863adac + supplierName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: 2dc0ef7c-582f-4542-963b-dbdc069e4819 + supplierName: Bayside Wholesale + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 961.21 + details: + - name: Bills + amount: 961.21 + - supplierId: 51cbbfb0-8dc9-41aa-aad6-eb93b3cc40c6 + supplierName: Capital Cab Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 242 + details: + - name: Bills + amount: 242 + - supplierId: 3828f379-afa5-4b2a-9000-9c53d75ba1c6 + supplierName: Central Copiers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1063.56 + details: + - name: Bills + amount: 1063.56 + - supplierId: 8a593982-291c-4ec3-9a42-3dbccbc6e3c8 + supplierName: MCO Cleaning Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.08 + details: + - name: Bills + amount: 119.08 + - supplierId: 97cc88ca-f89b-41f0-b8b9-e750b6f2f1d9 + supplierName: Net Connect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.13 + details: + - name: Bills + amount: 54.13 + - supplierId: dec56ceb-65e9-43b3-ac98-7fe09eb37e31 + supplierName: PowerDirect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 244.45 + details: + - name: Bills + amount: 244.45 + - supplierId: f5a77e82-50e3-4340-a6e0-13d6a482a08a + supplierName: SMART Agency + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4500 + details: + - name: Bills + amount: 4500 + - supplierId: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 93.64 + details: + - name: Bills + amount: 93.64 + - supplierId: ac48c67d-3eea-44eb-96b1-9f7a89d9b761 + supplierName: Xero + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56.35 + details: + - name: Bills + amount: 56.35 + - supplierId: 94a82e91-53da-4f87-a417-63d6a1607ced + supplierName: Young Bros Transport + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 125.03 + details: + - name: Bills + amount: 125.03 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/balanceSheet': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get balance sheet + description: Gets the latest balance sheet for a company. + operationId: get-accounting-balance-sheet + x-speakeasy-group: financial-statements.balance-sheet + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBalanceSheet' + examples: + Clear Books: + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 4643976.27 + items: + - accountId: '' + name: Fixed Assets + value: 3930291.27 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2354838.89 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1575452.38 + items: [] + - accountId: '' + name: Current Assets + value: 713685 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 66538.63 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 27250.93 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 113157.44 + items: [] + - accountId: '' + name: Bank + value: 506738 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 506738 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1183797.31 + items: + - accountId: '' + name: Current Liabilities + value: 544797.71 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 27683.3 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 8985.44 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 36981.83 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1193.59 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1147.11 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 439935.82 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 28870.62 + items: [] + - accountId: '' + name: Long Term Liability + value: 638999.6 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 638999.6 + items: [] + netAssets: 3460178.96 + equity: + accountId: '' + name: Equity + value: 3460178.96 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 54977.57 + items: [] + - date: '2023-02-28T00:00:00' + assets: + accountId: '' + name: Assets + value: 4599890.71 + items: + - accountId: '' + name: Fixed Assets + value: 3882793.51 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2036803.36 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1845990.15 + items: [] + - accountId: '' + name: Current Assets + value: 717097.2 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 136245.44 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 18719.25 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 146898.62 + items: [] + - accountId: '' + name: Bank + value: 415233.89 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 415233.89 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1150262.51 + items: + - accountId: '' + name: Current Liabilities + value: 508579.57 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 22517.83 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 5994.86 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 49993.06 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1424.88 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1863.01 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 399839.88 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 26946.05 + items: [] + - accountId: '' + name: Long Term Liability + value: 641682.94 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 641682.94 + items: [] + netAssets: 3449628.2 + equity: + accountId: '' + name: Equity + value: 3449628.19 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 44426.8 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + currency: GBP + reports: + - date: '2023-03-27T00:00:00' + assets: + name: Assets + value: 260454.26 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 36998.49 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35824.11 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70020.01 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 189399.22 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 129008.09 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71992.44 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 26065.84 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 26065.84 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99721.85 + items: + - name: Current Liabilities + value: 99735.85 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42435.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57906.98 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 160732.41 + equity: + name: Equity + value: 160732.41 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 71020.55 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 262531.32 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 37693.84 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35778.16 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70669.41 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 188021.29 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 127634.34 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71988.26 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 28825.48 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 28825.48 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99680 + items: + - name: Current Liabilities + value: 99694 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42459.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57841.13 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 162851.32 + equity: + name: Equity + value: 162851.32 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 73139.46 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Exact (Netherlands): + value: + reports: [] + Exact (UK): + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00Z' + assets: + name: Assets + value: -2 + items: + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: -3 + items: [] + - accountId: ba382d88-a4e5-4117-8fc6-4752ee8bc93d + name: 15801 - Standard account + value: 1 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: -2 + equity: + name: Equities + value: -2 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -2 + items: [] + - date: '2022-09-30T00:00:00Z' + assets: + name: Assets + value: 208 + items: + - accountId: 885ff551-664d-451b-995b-cb114c9877d0 + name: 15890 - Unallocated Cash + value: 0 + items: [] + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: 78 + items: [] + - accountId: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: 15880 - Bank + value: 130 + items: [] + liabilities: + name: Liabilities + value: 0 + items: + - accountId: 88d733a8-51e1-4ee7-b2a0-fb49879e36cc + name: 21000 - Trade Creditors + value: 0 + items: [] + netAssets: 208 + equity: + name: Equities + value: 208 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: 208 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + FreshBooks: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + KashFlow: + value: + currency: GBP + reports: + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + - date: '2022-08-31T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + mostRecentAvailableMonth: '2022-09-30T00:00:00' + earliestAvailableMonth: '2022-03-01T00:00:00' + MYOB AccountRight and Essentials: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Oracle NetSuite: + value: + currency: GBP + reports: + - date: '2023-05-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + - date: '2023-04-30T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + mostRecentAvailableMonth: '2023-05-31T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: ASSETS + value: 549695.86 + items: + - name: Current Assets + value: 81821.64 + items: + - name: Checking/Savings + value: 57007.53 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 40814.11 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 7719.99 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 7719.99 + items: [] + - name: Other Current Assets + value: 17094.12 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13177.4 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 1350 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 451499.2 + items: + - name: Current Liabilities + value: 6718.02 + items: + - name: Accounts Payable + value: 5000 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5000 + items: [] + - name: Credit Cards + value: 1400 + items: + - accountId: 570000-1071509253 + name: 20500 � QuickBooks Credit Card + value: 1400 + items: [] + - name: Other Current Liabilities + value: 318.02 + items: + - accountId: 100000-933270541 + name: 25500 � Sales Tax Payable + value: 318.02 + items: [] + - name: Long Term Liabilities + value: 444781.18 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 19932.64 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 50644.52 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 98196.66 + equity: + name: Equity + value: 98196.66 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 22708.94 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: ASSETS + value: 547971.05 + items: + - name: Current Assets + value: 80096.83 + items: + - name: Checking/Savings + value: 45769.39 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 29575.97 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 16228.47 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 16228.47 + items: [] + - name: Other Current Assets + value: 18098.97 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13507.25 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 2025 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 453300.75 + items: + - name: Current Liabilities + value: 5714 + items: + - name: Accounts Payable + value: 5714 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5714 + items: [] + - name: Long Term Liabilities + value: 447586.75 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 20376.27 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 53006.46 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 94670.3 + equity: + name: Equity + value: 94670.3 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 19182.58 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online Sandbox: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: Assets + value: 3856584.88 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 520021.91 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 17546.08 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -15900.6 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 211127.4 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109500.4 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128050.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -29.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: 2655 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24513.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3074459.19 + items: + - accountId: '70' + name: Debtors + value: 3041138.07 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -7.45 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259337.61 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36524 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220930.75 + items: [] + liabilities: + name: Liabilities + value: 169469.71 + items: + - name: Accounts Payable + value: 93748.74 + items: + - accountId: '71' + name: Creditors + value: 93635.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 10841.34 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 9957.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2469.91 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3425.44 + items: [] + - name: Other Current Liability + value: 10001.33 + items: + - accountId: '118' + name: Current Liabilities + value: 82.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -4738.49 + items: [] + - accountId: '54' + name: VAT Suspense + value: 5390 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3687115.17 + equity: + name: Equity + value: 3687115.17 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -10470.26 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 4385453.25 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 1048102.14 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 14029.28 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -11410.5 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 741293.8 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109155.93 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128055.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -14.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: -5 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24438.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3075173.68 + items: + - accountId: '70' + name: Debtors + value: 3041854.11 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -9 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259411.26 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36533.45 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220994.95 + items: [] + liabilities: + name: Liabilities + value: 699368.94 + items: + - name: Accounts Payable + value: 93773.74 + items: + - accountId: '71' + name: Creditors + value: 93660.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 12226.79 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 11004.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2471.46 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3765.44 + items: [] + - name: Other Current Liability + value: 538490.11 + items: + - accountId: '118' + name: Current Liabilities + value: 72.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -3792.71 + items: [] + - accountId: '54' + name: VAT Suspense + value: 532943 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3686084.31 + equity: + name: Equity + value: 3686084.31 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -11501.12 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online: + value: + reports: [] + Sage 50 (UK): + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 1740591.73 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1425254.88 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.71 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: bb6151d3fd744fa6a81f2164b1d156dc + name: 13918348 - PUSH 1 Matt Ager Test EUR Account + value: 9 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 173084617.49 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 183778965.2 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57234.67 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199200.59 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10893226.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -171344025.76 + equity: + name: Equities + value: -171344025.76 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -171344025.76 + items: [] + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 1748139.93 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1432812.05 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.74 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 161482418.52 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 171440565.23 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57232.9 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199003.36 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10156826.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -159734278.59 + equity: + name: Equities + value: -159734278.59 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -159734278.59 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + Wave: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 2220.87 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 219 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4641.15 + items: + - name: Current Liabilities + value: 4641.15 + items: + - name: Accounts Payable + value: 3557.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -2420.28 + equity: + name: Equity + value: -2420.28 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -2484.08 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Nov 30, 2022' + value: -533.49 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 2222.22 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 220.35 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4086.15 + items: + - name: Current Liabilities + value: 4086.15 + items: + - name: Accounts Payable + value: 3002.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -1863.93 + equity: + name: Equity + value: -1863.93 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -1927.73 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Oct 31, 2022' + value: 22.86 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Xero: + value: + currency: GBP + reports: + - date: '2023-03-31T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + - date: '2023-02-28T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Zoho Books: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + - date: '2022-09-01T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/profitAndLoss': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get profit and loss + description: Gets the latest profit and loss for a company. + operationId: get-accounting-profit-and-loss + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingProfitAndLossReport' + examples: + Clear Books: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + accountId: '' + name: Income + value: 146840.42 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 146840.42 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 29955.45 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 29955.45 + items: [] + grossProfit: 116884.97 + expenses: + accountId: '' + name: Expenses + value: 62407.18 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 24962.87 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 1550.12 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 1410.61 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 1283.66 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 1168.13 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 944.89 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 977.96 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 889.94 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 719.86 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 6000.46 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 609.29 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 630.62 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 510.1 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 527.95 + items: [] + netOperatingProfit: 54477.79 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 54977.57 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + accountId: '' + name: Income + value: 108461.81 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 108461.81 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 18438.51 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 18438.51 + items: [] + grossProfit: 90023.3 + expenses: + accountId: '' + name: Expenses + value: 46096.28 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 18438.51 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 669.33 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 609.09 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 554.28 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 448.35 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 412.48 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 426.92 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 388.49 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 314.25 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 325.25 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 2600.97 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 239.41 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 220.26 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 227.97 + items: [] + netOperatingProfit: 43927.02 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 44426.8 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 658.5 + items: + - name: Sales Returns & Allowances + value: 0 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: 0 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: 0 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: 0 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: 0 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: 0 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 658.5 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 658.5 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 0 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 2735.64 + items: + - name: Materials + value: 2735.64 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 2735.64 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: -2077.14 + expenses: + name: Expense + value: 41.77 + items: + - name: '' + value: 0 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 0 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: 0 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: 0 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 41.77 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 41.77 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -2118.91 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2118.91 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 414.51 + items: + - name: Sales Returns & Allowances + value: -125.17 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: -125.17 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: -10 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: -10 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: -12.91 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: -12.91 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 430.4 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 430.4 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 132.19 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 132.19 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 328 + items: + - name: Materials + value: 328 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 328 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: 86.51 + expenses: + name: Expense + value: 1482.02 + items: + - name: '' + value: 9.52 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 9.52 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: -1.82 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: -1.82 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 1474.32 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 1474.32 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -1395.51 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -1395.51 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Exact (Netherlands): + value: + reports: + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: -286 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: -286 + items: [] + - accountId: 0b5b5d8b-1c0c-4767-88d8-c99206da6ace + name: 555777 - Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -286 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -286 + otherExpenses: + name: Other Expenses + value: 5.25 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 5.25 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -5.25 + netProfit: -291.25 + - fromDate: '2022-08-01T00:00:00Z' + toDate: '2022-08-31T00:00:00Z' + income: + name: Income + value: 664.73 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: 643.33 + items: [] + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: -13.6 + items: [] + - accountId: f93008c5-f45b-4200-82a8-d0d5e1584ee7 + name: 1234567 - james_test2 + value: 35 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 664.73 + expenses: + name: Expenses + value: 13.6 + items: + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: 13.6 + items: [] + netOperatingProfit: 651.13 + otherExpenses: + name: Other Expenses + value: 45 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 45 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -45 + netProfit: 606.13 + reportBasis: Unknown + currency: EUR + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Exact (UK): + value: + reports: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + income: + name: Income + value: -2 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: -2 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -2 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -2 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2 + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: 208 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: 208 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 208 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 208 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 208 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 24.05 + items: + - accountId: '3384197' + name: Advertising + value: 0.21 + items: [] + - accountId: '3380421' + name: Car & Truck Expenses + value: 11 + items: [] + - accountId: '3361426' + name: Meals & Entertainment + value: 12.82 + items: [] + - accountId: '3379249' + name: Supplies + value: 0.02 + items: [] + netOperatingProfit: -24.05 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -24.04 + reportBasis: Cash + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + KashFlow: + value: + reports: + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-08-01T00:00:00' + toDate: '2022-08-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-10-01T00:00:00' + MYOB AccountRight and Essentials: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Oracle NetSuite: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: -123.45 + items: + - accountId: '58' + name: Expenses + value: -123.45 + items: [] + netOperatingProfit: 123.45 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 123.45 + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 11 + items: + - accountId: '108' + name: Shipping and Handling + value: 11 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 11 + expenses: + name: Expenses + value: 11 + items: + - accountId: '58' + name: Expenses + value: 11 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 7673.5 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 7673.5 + items: + - accountId: 190000-933270541 + name: 40130 � Labor Income + value: 840 + items: [] + - accountId: 1A0000-933270542 + name: 40140 � Materials Income + value: 4103.5 + items: [] + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 2730 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 1729.85 + items: + - accountId: 1E0000-933270542 + name: 50100 � Cost of Goods Sold + value: 329.85 + items: [] + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 1400 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 1400 + items: [] + grossProfit: 5943.65 + expenses: + name: Expense + value: 2417.29 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 1066.56 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 162 + items: [] + - accountId: 580000-1071498064 + name: 60120 � Insurance + value: 712.56 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 192 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 438.3 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 438.3 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 224.93 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 120.93 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 3526.36 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 3526.36 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 16500 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 16500 + items: + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 16500 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 7500 + items: + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 7500 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 7500 + items: [] + grossProfit: 9000 + expenses: + name: Expense + value: 3159.99 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 359 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 127 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 232 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 456.29 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 456.29 + items: [] + - accountId: 3D0000-933270542 + name: 64200 � Repairs + value: 1164 + items: + - accountId: 3F0000-933270542 + name: 64220 � Computer Repairs + value: 714 + items: [] + - accountId: 400000-933270542 + name: 64230 � Equipment Repairs + value: 450 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 493.2 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 389.2 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 5840.01 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 93.42 + items: + - accountId: 4C0000-933270542 + name: 70200 � Interest Income + value: 93.42 + items: [] + netOtherIncome: 93.42 + netProfit: 5933.43 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 35.7 + items: + - accountId: '68' + name: Billable Expenses Income + value: -15 + items: [] + - accountId: '44' + name: Sales + value: 130 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 42.5 + items: [] + - accountId: '1' + name: Services + value: -131.8 + items: [] + - accountId: '149' + name: Shipping Income + value: 10 + items: [] + costOfSales: + name: Cost of Sales + value: -8.16 + items: + - accountId: '67' + name: Cost of sales + value: 33.51 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: -41.67 + items: [] + grossProfit: 43.86 + expenses: + name: Expenses + value: -987 + items: + - accountId: '148' + name: Billable Test + value: -250 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: -897 + items: [] + - accountId: '18' + name: Depreciation Expense + value: 100 + items: [] + - accountId: '19' + name: Dues and Subscriptions + value: -40 + items: [] + - accountId: '64' + name: Purchases + value: 100 + items: [] + netOperatingProfit: 1030.86 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 1030.86 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 1664.93 + items: + - accountId: '14' + name: Commission Income + value: 64 + items: [] + - accountId: '44' + name: Sales + value: 952.29 + items: [] + - accountId: '43' + name: Sales Discounts + value: 9.05 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 223.52 + items: [] + - accountId: '1' + name: Services + value: 392.32 + items: [] + - accountId: '149' + name: Shipping Income + value: 23.75 + items: [] + costOfSales: + name: Cost of Sales + value: 2568.09 + items: + - accountId: '67' + name: Cost of sales + value: 27.09 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: 41 + items: [] + - accountId: '10' + name: Entertainment Booking Fees paid on behalf of clients + value: 2500 + items: [] + grossProfit: -903.16 + expenses: + name: Expenses + value: 397.62 + items: + - accountId: '148' + name: Billable Test + value: -35.75 + items: [] + - accountId: '12' + name: Business Licenses and Permits + value: -8 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: 42.46 + items: [] + - accountId: '20' + name: Equipment rental + value: -22.76 + items: [] + - accountId: '116' + name: HM Revenue & Customs (VAT) Expense + value: -25.2 + items: [] + - accountId: '24' + name: Insurance Expense + value: 5.32 + items: [] + - accountId: '23' + name: Insurance Expense-Health Insurance + value: -34 + items: [] + - accountId: '31' + name: Marketing Expense + value: -11.56 + items: [] + - accountId: '35' + name: Office Supplies + value: -12.89 + items: [] + - accountId: '64' + name: Purchases + value: 500 + items: [] + netOperatingProfit: -1300.78 + otherExpenses: + name: Other Expenses + value: 11.92 + items: + - accountId: '52' + name: Exchange Gain or Loss + value: 11.92 + items: [] + otherIncome: + name: Other Income + value: 29.41 + items: + - accountId: '21' + name: Finance Charge Income + value: -13.44 + items: [] + - accountId: '27' + name: Insurance Proceeds Received + value: 7.85 + items: [] + - accountId: '29' + name: Interest income + value: 15 + items: [] + - accountId: '39' + name: Proceeds from Sale of Assets + value: 20 + items: [] + netOtherIncome: 17.49 + netProfit: -1283.29 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 4300 + items: + - accountId: '68' + name: 303 HM Revenue & Customs (VAT) Expense + value: 250 + items: [] + - accountId: '22' + name: 408 Travelling expenses + value: 4050 + items: [] + netOperatingProfit: -4300 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -4300 + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 10 + items: + - accountId: '16' + name: 292 Advertising + value: 10 + items: [] + netOperatingProfit: -10 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -10 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-01-01T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Sage 200cloud: + value: + reports: + - fromDate: '2020-12-01T00:00:00Z' + toDate: '2020-12-31T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2020-11-01T00:00:00Z' + toDate: '2020-11-30T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2020-12-01T00:00:00' + earliestAvailableMonth: '2015-01-01T00:00:00' + Sage 50 (UK): + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: -7749 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: -7740 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -9 + items: [] + costOfSales: + name: Cost of Sales + value: 11602000 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 11602000 + items: [] + grossProfit: -11609749 + expenses: + name: Expenses + value: -1.83 + items: + - accountId: 9a99a91c267a11e797950a57719b2edb + name: 8211 - Exchange rate gain/(loss) + value: -1.83 + items: [] + netOperatingProfit: -11609747.17 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -11609747.17 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 501 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: 511 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -10 + items: [] + costOfSales: + name: Cost of Sales + value: 13220073.7 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 13220073.7 + items: [] + grossProfit: -13219572.7 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -13219572.7 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: -148.34 + items: + - accountId: 9a995491267a11e797950a57719b2edb + name: 4900 - Other income + value: -148.34 + items: [] + netOtherIncome: -148.34 + netProfit: -13219721.04 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Wave: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 7.01 + items: + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 7.01 + expenses: + name: Operating Expenses + value: 555 + items: + - name: Office Supplies + value: 555 + items: [] + netOperatingProfit: -547.99 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -547.99 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 8.36 + items: + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 8.36 + expenses: + name: Operating Expenses + value: 0 + items: [] + netOperatingProfit: 8.36 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 8.36 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 14496.51 + items: + - accountId: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + value: 14496.51 + items: [] + costOfSales: + name: Cost of Sales + value: 700 + items: + - accountId: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b + name: Purchases + value: 700 + items: [] + grossProfit: 13796.51 + expenses: + name: Expenses + value: 2026.92 + items: + - accountId: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + value: 215.87 + items: [] + - accountId: d50842c3-af67-4233-b8c9-df3180f5b7bd + name: 'Light, Power, Heating' + value: 103.43 + items: [] + - accountId: 0be1631e-cc7e-4c27-951f-308c3307c0fe + name: Motor Vehicle Expenses + value: 342.79 + items: [] + - accountId: a49cc958-968e-4b54-96d6-8853c036009e + name: 'Postage, Freight & Courier' + value: 94.19 + items: [] + - accountId: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + value: 24.58 + items: [] + - accountId: dae8e236-24bb-4a7a-9787-c5fd89385e03 + name: Rent + value: 984.38 + items: [] + - accountId: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + value: 14.9 + items: [] + - accountId: f3c73c3d-9887-4377-b18b-0374ab62e4aa + name: Telephone & Internet + value: 45.11 + items: [] + - accountId: c7b73345-7f25-428a-bb97-7b20a1470a53 + name: Travel - National + value: 201.67 + items: [] + netOperatingProfit: 11769.59 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 11769.59 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Operating Income + value: 0 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 0 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Operating Expense + value: 0 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 0 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Operating Income + value: 69 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 69 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 35 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 35 + items: [] + grossProfit: 34 + expenses: + name: Operating Expense + value: 69 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 69 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: -35 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -35 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/cashFlowStatement': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get cash flow statement + description: Gets the latest cash flow statement for a company. + operationId: get-accounting-cash-flow-statement + x-speakeasy-group: financial-statements.cash-flow + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCashFlowStatement' + examples: + Clear Books: + value: + reports: + - fromDate: '2021-02-01T00:00:00' + toDate: '2021-02-28T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 18377.72 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 11417.63 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 6960.09 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 12377.81 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 7479.21 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 700 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 4198.6 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + - fromDate: '2021-01-01T00:00:00' + toDate: '2021-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 14508.56 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 3055.53 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 11453.03 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 18902.85 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 9673.66 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 1250 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 7979.19 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2021-02-28T00:00:00' + earliestAvailableMonth: '2019-03-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + reportBasis: Cash + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 754.59 + items: + - accountId: income + name: Income + value: 729.59 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 25 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: -987.94 + items: + - accountId: costOfSales + name: Cost of Sales + value: 24.06 + items: [] + - accountId: expenses + name: Expenses + value: -1012 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 1776.25 + items: + - accountId: income + name: Income + value: 1652.12 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 124.13 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 2494.43 + items: + - accountId: costOfSales + name: Cost of Sales + value: 2562 + items: [] + - accountId: accountsPayable + name: Accounts Payable + value: 38.02 + items: [] + - accountId: expenses + name: Expenses + value: -105.59 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 4300 + items: + - accountId: expenses + name: Expenses + value: 4300 + items: [] + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 10 + items: + - accountId: expenses + name: Expenses + value: 10 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-01-31T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: 0 + items: + - accountId: income + name: Net Income + value: 0 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 0 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 0 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: -5 + items: + - accountId: income + name: Net Income + value: -35 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 30 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 7 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 7 + items: [] + reportBasis: Accrual + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2019-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accountBalances': + get: + tags: + - Bank statements + summary: List account balances + operationId: list-banking-account-balances + x-speakeasy-group: banking.account-balances + description: "The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection.\n\n[Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccountBalances' + examples: + Basiq: + value: + results: + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 11389.85 + date: '2017-12-31T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 8002.09 + date: '2018-01-01T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3103 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=2&pageSize=2 + Plaid: + value: + results: + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-13T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-14T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts': + get: + tags: + - Bank statements + summary: List accounts + operationId: list-banking-accounts + x-speakeasy-group: banking.accounts + description: "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccounts' + examples: + Basiq: + value: + results: + - id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + - id: 736d90a5-f836-4ae0-a161-1e8056f39701 + name: Standard Variable Rate Home Loan + holder: david smith + type: Credit + balance: + available: 6940.31 + current: 6940.31 + identifiers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Standard Variable Rate Home Loan + accountHolder: david smith + accountType: Credit + accountNumbers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=2&pageSize=2 + Plaid: + value: + results: + - id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}': + get: + tags: + - Bank statements + summary: Get account + operationId: get-banking-account + x-speakeasy-group: banking.accounts + description: |- + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccount' + examples: + Basiq: + value: + id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + Plaid: + value: + id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transactions + x-speakeasy-group: banking.transactions + summary: List transactions + description: "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/BankingTransactions' + examples: + Basiq: + value: + results: + - id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + - id: 0023c431-35c8-41f5-b75e-9239413cde7e + accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + description: Transfer from xx9263 CommBank app Shop + amount: 191 + currency: AUD + postedDate: '2018-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: transfer + name: Transfer + modifiedDate: '2022-10-28T07:15:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3319 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=2&pageSize=2 + Plaid: + value: + results: + - id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + - id: 1514wvMMajumgG7xWA1Bt8oDLxlpm3i3zraD7_6DB63D1DACF6F5824C80F8BE2E066DB5 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2022-10-02T00:00:00' + authorizedDate: '2022-10-01T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 49 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionId + in: path + required: true + description: The unique identifier for a transaction + get: + summary: Get bank transaction + tags: + - Bank statements + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransaction' + examples: + Basiq: + value: + id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + Plaid: + value: + id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-banking-transaction + x-speakeasy-group: banking.transactions + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transaction-categories + x-speakeasy-group: banking.transaction-categories + summary: List transaction categories + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategories' + examples: + Basiq: + value: + results: + - id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + - id: cash-withdrawal + name: Cash Withdrawal + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=2&pageSize=2 + Plaid: + value: + results: + - id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + - id: BANK_FEES.BANK_FEES_ATM_FEES + name: BANK_FEES_ATM_FEES + parentId: BANK_FEES + hasChildren: false + status: Active + modifiedDate: '2022-10-27T10:50:17' + pageNumber: 1 + pageSize: 2 + totalResults: 120 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection.\n\n[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionCategoryId + in: path + required: true + description: The unique identifier for a banking transaction category + get: + tags: + - Bank statements + operationId: get-banking-transaction-category + x-speakeasy-group: banking.transaction-categories + summary: Get transaction category + description: | + The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. + + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategory' + examples: + Basiq: + value: + id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + Plaid: + value: + id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Sales + summary: List customers + operationId: list-commerce-customers + x-speakeasy-group: sales.customers + description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCustomers' + examples: + BigCommerce: + value: + results: + - id: '1' + customerName: Amy Jones + emailAddress: a.jackson@email.me + defaultCurrency: XXX + phone: 07770 666777 + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + - id: '2' + customerName: Cust001 Cust001 + emailAddress: Cust001@example.com + defaultCurrency: XXX + phone: 05442 203941 + addresses: [] + createdDate: '2023-04-11T15:49:25Z' + modifiedDate: '2023-04-17T15:42:55Z' + sourceModifiedDate: '2023-04-11T15:49:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 201 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=2&pageSize=2 + Clover: + value: + results: + - id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: 511JV0FRN2QYC + customerName: '' + addresses: [] + createdDate: '2021-09-21T14:54:38Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=2&pageSize=2 + Mollie: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + - id: '3' + customerName: Fake Name + emailAddress: bob@bob.com + addresses: [] + createdDate: '2021-09-03T01:55:13' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-03T01:55:13' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=2&pageSize=2 + Shopify: + value: + results: + - id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + - id: '5097398534302' + customerName: Qa Test + phone: '+445593368390' + addresses: + - type: Unknown + line1: Look Street + city: London + postalCode: PO16 7GZ + - type: Unknown + line1: Look Street + city: London + region: England + country: United Kingdom + postalCode: PO16 7GZ + note: '' + createdDate: '2021-03-19T10:12:37' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:07:59' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=2&pageSize=2 + Square: + value: + results: + - id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + - id: GXQDPSZSMN6C58270SZN4YJZ8R + emailAddress: s.shandil+square@codat.io + phone: '+447729946295' + addresses: [] + createdDate: '2020-11-19T14:56:00Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-11-19T14:56:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers + Stripe Test: + value: + results: + - id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: cus_LXdFFgHqqVURIv + customerName: David Dunlow + emailAddress: david@example.com + defaultCurrency: gbp + phone: '+447545309714' + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + - type: Delivery + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + note: Test Subscriptions + createdDate: '2022-04-20T07:30:01Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers + Zettle: + value: + results: + - id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + - id: joe@bloggs.com + customerName: Joe Bloggs + emailAddress: joe@bloggs.com + phone: 02012 345678 + addresses: + - type: Unknown + line1: Flat 1 + line2: 1 High Street + city: London + region: London + country: GB + - type: Unknown + line1: Flat 2 + line2: 2 High Street + city: London + region: London + country: GB + createdDate: '2020-12-21T14:52:15' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2020-12-21T14:52:15' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Sales + summary: Get customer + operationId: get-commerce-customer + x-speakeasy-group: sales.customers + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCustomer' + examples: + BigCommerce: + value: + id: '1' + customerName: Amy Jones + emailAddress: a.durbanjackson+amy@codat.io + defaultCurrency: XXX + phone: '07770666777' + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + Clover: + value: + id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Mollie: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + PrestaShop: + value: + id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + Shopify: + value: + id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + Square: + value: + id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + Stripe Test: + value: + id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + WooCommerce: + value: + id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + Zettle: + value: + id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List disputes + tags: + - Sales + operationId: list-commerce-disputes + x-speakeasy-group: sales.disputes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceDisputes' + examples: + Shopify: + value: + results: + - id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + - id: '8502444190' + disputedTransactions: + - id: '3684119445662' + type: Order + totalAmount: 600 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:18:31' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:18' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes + Stripe Test: + value: + results: + - id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: dp_1HqiwVA8m8S1Gh7OpS3ozlcd + disputedTransactions: + - id: txn_1HqiwVA8m8S1Gh7O0IVelTQ5 + type: Payment + totalAmount: 55 + currency: GBP + status: Lost + reason: product_not_received + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T17:35:11Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection.\n\n[Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: disputeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a dispute. + get: + summary: Get dispute + tags: + - Sales + operationId: get-commerce-dispute + x-speakeasy-group: sales.disputes + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceDispute' + examples: + Shopify: + value: + id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + Stripe Test: + value: + id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get dispute* endpoint returns a single dispute for a given disputeId. + + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-info': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get company commerce profile + tags: + - Company info + operationId: get-commerce-profile + x-speakeasy-name-override: get-commerce-profile + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + baseCurrency: GBP + accountBalances: + - available: 20053.23 + pending: 2034.23 + reserved: 517.23 + currency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2019-03-07T16:50:49' + modifiedDate: '2022-03-10T15:42:13' + sourceModifiedDate: '2021-06-10T01:48:49' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Retrieve information about the company, as seen in the commerce + platform. + + This may include information like addresses, tax registration details and + social media or website information." + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List locations + tags: + - Sales + operationId: list-commerce-locations + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocations' + examples: + Clover: + value: + results: + - id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations + Lightspeed K Trial: + value: + results: + - id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations + Shopify: + value: + results: + - id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations + Square: + value: + results: + - id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection.\n\n[Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: locationId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a location. + get: + summary: Get location + tags: + - Sales + operationId: get-commerce-location + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocation' + examples: + Clover: + value: + id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + Lightspeed K Trial: + value: + id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + Shopify: + value: + id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + Square: + value: + id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get location* endpoint returns a single location for a given locationId. + + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List orders + tags: + - Sales + operationId: list-commerce-orders + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrders' + examples: + Amazon Seller Central: + value: + results: + - id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders + BigCommerce: + value: + results: + - id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + - id: '101' + orderNumber: '101' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:49:02Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '3' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '4' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:49:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=2&pageSize=2 + Clover: + value: + results: + - id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + - id: 0G22TXMYQQE54 + orderNumber: 0G22TXMYQQE54 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T11:24:48Z' + totalAmount: 1340 + totalRefund: 0 + totalTaxAmount: 240 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: GZ73TPFAV6NTP + quantity: 1 + taxPercentage: 20 + totalAmount: 1440 + totalTaxAmount: 240 + unitPrice: 1200 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 240 + productRef: + id: QVAV6KM1457B0 + name: Desktop + discountAllocations: [] + - id: 'Discount: �10 off' + quantity: 1 + taxPercentage: 0 + totalAmount: -100 + totalTaxAmount: 0 + unitPrice: 0 + taxes: [] + discountAllocations: + - name: �10 off + totalAmount: 100 + payments: + - id: H726AAJQYE3SP + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T11:24:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 76 + _links: + current: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders + next: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + - id: A61465.2 + orderNumber: A61465.2 + country: 'AU ' + currency: AUD + createdDate: '2022-12-12T23:20:12Z' + closedDate: '2022-12-12T23:21:29Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 0.91 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.2 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.46 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.46 + productRef: + id: '647208621834663' + name: Royal + discountAllocations: [] + - id: S61465.3 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834623' + name: Mocha + discountAllocations: [] + payments: + - id: 'R61465.2_1_A61465.2_2022-12-12T23:21:29.006Z' + amount: 10 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-12T23:21:29' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=2&pageSize=2 + Mollie: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders + Mollie Test: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders + Partner Commerce: + value: + results: + - id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders + PrestaShop: + value: + results: + - id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + - id: '10' + orderNumber: UFQZXPGQU + country: 'US ' + currency: USD + createdDate: '2021-09-28T08:09:46' + totalAmount: 19.12 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 4.78 + totalGratuity: 0 + orderLineItems: + - id: '14' + quantity: 1 + taxPercentage: 0 + totalAmount: 19.12 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: + - name: 20% Discount + totalAmount: 4.78 + payments: [] + serviceCharges: [] + customerRef: + id: '5' + name: Tobi Yinusa + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-28T08:09:46' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=2&pageSize=2 + Shopify: + value: + results: + - id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + - id: '3684180361374' + orderNumber: '1011' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:57:30' + totalAmount: 105 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670570901662' + quantity: 3 + taxPercentage: 0 + totalAmount: 105 + totalTaxAmount: 0 + unitPrice: 35 + taxes: [] + productRef: + id: '6595497787550' + name: Keyboard + productVariantRef: + id: '39444537213086' + name: Keyboard + discountAllocations: [] + payments: + - id: '4630311108766' + amount: 105 + currency: GBP + type: Unknown + status: Paid + paymentProvider: Manual + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:57:30' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:57:30' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=2&pageSize=2 + Square: + value: + results: + - id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + orderNumber: TNEU7333HZ + country: XXX + currency: GBP + createdDate: '2021-03-26T21:09:59Z' + totalAmount: 15 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Sale of some product + quantity: 1 + taxPercentage: 0 + totalAmount: 15 + totalTaxAmount: 0 + unitPrice: 15 + taxes: [] + discountAllocations: [] + payments: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + - id: '145' + orderNumber: '145' + country: 'GB ' + currency: GBP + createdDate: '2021-09-24T12:15:29Z' + totalAmount: 27.5 + totalRefund: 0 + totalTaxAmount: 5.5 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '59' + quantity: 2 + taxPercentage: 25 + totalAmount: 27.5 + totalTaxAmount: 5.5 + unitPrice: 11 + taxes: [] + productRef: + id: '87' + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2022-03-24T16:01:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 25 + _links: + current: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders + next: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=2&pageSize=2 + Zettle: + value: + results: + - id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + - id: CV5TJC2YEeueVK3fSQEQIw + orderNumber: '4' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:28:05Z' + totalAmount: 25 + totalRefund: 0 + totalTaxAmount: 1.19 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 5 + totalAmount: 25 + totalTaxAmount: 1.19 + unitPrice: 23.81 + taxes: [] + productRef: + id: 89570bee-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 89570c52-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:28:05Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection.\n\n[Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: orderId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an order. + get: + summary: Get order + tags: + - Sales + operationId: get-commerce-order + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrder' + examples: + Amazon Seller Central: + value: + id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + BigCommerce: + value: + id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + Clover: + value: + id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + Lightspeed K Trial: + value: + id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + Mollie: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + Partner Commerce: + value: + id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + PrestaShop: + value: + id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + Shopify: + value: + id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + Square: + value: + id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + WooCommerce: + value: + id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + Zettle: + value: + id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get order* endpoint returns a single order for a given orderId. + + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payment methods + tags: + - Sales + operationId: list-commerce-payment-methods + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethods' + examples: + Amazon Seller Central: + value: + results: + - id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + - id: GC + name: Gift Card + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + - id: bigcommerce_store_credit + name: Store Credit + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods + Clover: + value: + results: + - id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + - id: 24H1ANYP1BNXG + name: MyTab + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + - id: '647208621834261' + name: Credit Card + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods + next: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=2&pageSize=2 + Square: + value: + results: + - id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + - id: BUY_NOW_PAY_LATER + name: Buy Now Pay Later + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods + next: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=2&pageSize=2 + SumUp: + value: + results: + - id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + - id: CC_CUSTOMER_ENTERED + name: Credit Card + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection.\n\n[Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: paymentMethodId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment method. + get: + summary: Get payment method + tags: + - Sales + operationId: get-commerce-payment-method + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethod' + examples: + Amazon Seller Central: + value: + id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + BigCommerce: + value: + id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + Clover: + value: + id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + Lightspeed K Trial: + value: + id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + Mollie: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + Mollie Test: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + Square: + value: + id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + SumUp: + value: + id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. + + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payments + tags: + - Sales + operationId: list-commerce-payments + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayments' + examples: + BigCommerce: + value: + results: + - id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + - id: 105_2_2_refund + amount: -33.95 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-24T13:57:01Z' + modifiedDate: '2023-04-11T10:33:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=2&pageSize=2 + Clover: + value: + results: + - id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + - id: 0A8ZMPG40Q9AM + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:31Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:31Z' + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + paymentMethodRef: + id: '647208621834714' + name: LSPay - Mary + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46Z' + modifiedDate: '2023-03-02T09:50:43Z' + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=2&pageSize=2 + Mollie: + value: + results: + - id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + - id: re_NPKEJhQveu + amount: -60 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T16:15:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments + next: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + - id: '2' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:53:28' + modifiedDate: '2022-01-26T15:09:42Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=2&pageSize=2 + Shopify: + value: + results: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:18:29Z' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=2&pageSize=2 + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + amount: 15 + currency: GBP + type: Cash + status: Paid + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-03-17T16:13:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments + next: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + - id: '35' + amount: 30 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:08:56Z' + modifiedDate: '2021-07-13T16:19:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=2&pageSize=2 + Zettle: + value: + results: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + - id: 226580d6-2d98-11eb-a35c-fed5e63de507 + amount: 58.5 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:47Z' + modifiedDate: '2021-10-27T15:22:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/paymentId' + get: + summary: Get payment + tags: + - Sales + operationId: get-commerce-payment + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayment' + examples: + BigCommerce: + value: + id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + Clover: + value: + id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + Lightspeed K Trial: + value: + id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + Mollie: + value: + id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + PrestaShop: + value: + id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + Shopify: + value: + id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + WooCommerce: + value: + id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + Zettle: + value: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List product categories + tags: + - Sales + operationId: list-commerce-product-categories + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategories' + examples: + Lightspeed K Trial: + value: + results: + - id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + - id: '647208621834282' + name: NA beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: "The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection.\n\n[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product category + tags: + - Sales + operationId: get-commerce-product-category + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategory' + examples: + Lightspeed K Trial: + value: + id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-products': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List products + tags: + - Sales + operationId: list-commerce-products + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProducts' + examples: + Amazon Seller Central: + value: + results: + - id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + - id: vb554a-bl1915 + categorization: COAT + name: Waterproof Jacket + description: 'Wind and rainproof, keeping you dry all year round.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: 'ARRIS,SB6141' + name: Waterproof Jacket (Black) + quantity: 0 + isTaxEnabled: false + sku: 'ARRIS,SB6141' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: RTN66U-N9000 + name: Waterproof Jacket (Blue) + quantity: 0 + isTaxEnabled: false + sku: RTN66U-N9000 + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: TLWR841N + name: Waterproof Jacket (Red) + quantity: 0 + isTaxEnabled: false + sku: TLWR841N + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + - id: '104' + categorization: 'Shop All, Utility' + name: '[Sample] Utility Caddy' + description: 'This powder coated steel utility caddy ensures your cleaning essentials are stowed away in one spot ready for your household chores. Brushes, cloths, liquid soaps can all easily be stashed away. Also ideal to be used as a garden caddy to easily grab from the shed for a days work. Works well as a mop bucket too. The wood carrying handle ensures a comfortable grip when toting it from room to room. Measures 19 h x 36 w x 20 dia cm/7.5 h x 14.1 w x 7.8 dia in' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '72' + name: '[Sample] Utility Caddy' + quantity: 0 + isTaxEnabled: false + sku: OFSUC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 45.95 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:49:26Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2015-07-03T20:45:54Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=2&pageSize=2 + Clover: + value: + results: + - id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + - id: NMZHKK6FKF6ZJ + name: Laptop + description: Cool Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: NMZHKK6FKF6ZJ + name: Laptop + quantity: 0 + isTaxEnabled: true + sku: '111' + barcode: '123' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 1000 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T08:19:14Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + - id: '647208621834542' + categorization: NA beverages + name: NA beverages + description: NA beverages + productCategoryRefs: + - id: '647208621834282' + name: NA beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + - id: '10' + categorization: Home - Accessories - Home Accessories + name: Brown bear cushion + description: 'The brown bear cushion will add a graphic and colorful touch to your sofa, armchair or bed. Create a modern and zen atmosphere that inspires relaxation. Cover 100% cotton, machine washable at 60� / Filling 100% hypoallergenic polyester.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '24' + name: Brown bear cushion (Color = White) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '25' + name: Brown bear cushion (Color = Black) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 22 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=2&pageSize=2 + Shopify: + value: + results: + - id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + - id: '6595497066654' + categorization: Logitech + name: Mouse + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444533706910' + name: Mouse + quantity: 0 + isTaxEnabled: false + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 25 + inventory: + totalQuantity: 71 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:14:01Z' + createdDate: '2021-03-19T10:14:01Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=2&pageSize=2 + Square: + value: + results: + - id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + - id: FYRIQNFTFRGQNQZGZG66MJWI + categorization: Furniture + name: Desk + productCategoryRefs: [] + isGiftCard: false + variants: + - id: VMKSQEABA3WIYGXNAV63JOTZ + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 70 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:45Z' + createdDate: '2021-02-18T15:47:45Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:45Z' + status: Unknown + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products + next: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + - id: prod_IQ6G1MDsvUb87Y + name: Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1HpG3tA8m8S1Gh7Oa6bGLvVD + name: Laptop - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 100 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2020-11-19T16:32:45Z' + createdDate: '2020-11-19T16:32:45Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2022-05-12T23:31:33Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + - id: '28' + categorization: Hardware + name: Keyboard + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '28' + name: Keyboard + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T09:02:58' + createdDate: '2021-03-11T09:02:58' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:02:58' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=2&pageSize=2 + Zettle: + value: + results: + - id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + - id: e02c2930-a34a-11eb-b9db-8f5efc0924aa + categorization: Clothing + name: Hoodie + productCategoryRefs: [] + isGiftCard: false + variants: + - id: fa180e40-a34a-11eb-b9db-8f5efc0924aa + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fc412fd0-a34a-11eb-b9db-8f5efc0924aa + name: Extra Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: f8a03b50-a34a-11eb-b9db-8f5efc0924aa + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fac1bbc0-a34a-11eb-b9db-8f5efc0924aa + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:13:26Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:31:58Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: "The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection.\n\n[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product + tags: + - Sales + operationId: get-commerce-product + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProduct' + examples: + Amazon Seller Central: + value: + id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + BigCommerce: + value: + id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + Clover: + value: + id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + Lightspeed K Trial: + value: + id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + PrestaShop: + value: + id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + Shopify: + value: + id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + Square: + value: + id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + Stripe Test: + value: + id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + WooCommerce: + value: + id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + Zettle: + value: + id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List transactions + tags: + - Sales + operationId: list-commerce-transactions + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransactions' + examples: + Mollie: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=2&pageSize=2 + Shopify: + value: + results: + - id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + - id: 'ShopifyPayment-1633176289438:Fee' + totalAmount: -4.05 + currency: GBP + type: PaymentFee + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + - id: 'txn_1HpGQUA8m8S1Gh7OR21pB0Yj:Stripe processing fees' + totalAmount: -0.9 + currency: GBP + type: PaymentFee + subType: stripe_fee + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=2&pageSize=2 + SumUp: + value: + results: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + - id: 471914a4-a82f-4fc4-b39b-9986fd706d26 + totalAmount: 215 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-30T12:22:14Z' + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=2&pageSize=2 + Zettle: + value: + results: + - id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + - id: 'PAYMENT:226580d6-2d98-11eb-a35c-fed5e63de507' + totalAmount: 58.5 + currency: GBP + type: Payment + transactionSourceRef: + id: 226580d6-2d98-11eb-a35c-fed5e63de507 + type: Unknown + createdDate: '2020-11-23T14:28:20Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transactionId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transaction. + get: + summary: Get transaction + tags: + - Sales + operationId: get-commerce-transaction + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransaction' + examples: + Mollie: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + Shopify: + value: + id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + Stripe Test: + value: + id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + SumUp: + value: + id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + Zettle: + value: + id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: List all files uploaded by a company + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Files' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x66\x69\x6C\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x66\x69\x6C\x65\x73\x20\x75\x70\x6C\x6F\x61\x64\x65\x64\x20\x74\x6F\x20\x43\x6F\x64\x61\x74\x20\x62\x79\x20\x74\x68\x65\x20\x53\x4D\x42\x2E\x20" + operationId: list-files + x-speakeasy-name-override: list-uploaded + '/companies/{companyId}/files/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: Download all files for a company + parameters: + - name: date + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: Only download files uploaded on this date. + responses: + '200': + description: Success + content: + application/octet-stream: + x-speakeasy-usage-example: true + schema: + title: Data + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. + operationId: download-files + x-speakeasy-name-override: download + '/companies/{companyId}/connections/{connectionId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - File upload + summary: Upload files for a company + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUpload' + description: |- + The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data. + + Uploaded files must meet the following requirements: + + - Up to 20 files can be uploaded at a time. + - PDF, XLS, XLSX, XLSB, CSV, DOC, DOCX, PPT, PPTX, JPEG, JPG, and PNG files can be uploaded. + - Each file can be up to 10MB in size. + operationId: upload-files + x-speakeasy-name-override: upload + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update bank account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: 'Needs to be of the format ''{No.}-{Name}''' + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Bank Account Posting Group with Nominal Account must exist + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Must have a length between 0 and 20 characters + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: false + validation: + warnings: [] + information: + - field: OverdraftLimit + details: Default value is 0 + required: true + Exact (Netherlands): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must have a length between 0 and 8 characters + information: [] + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account + options: + - value: AED + type: String + displayName: AED + required: false + - value: AMD + type: String + displayName: AMD + required: false + - value: AOA + type: String + displayName: AOA + required: false + - value: ARS + type: String + displayName: ARS + required: false + - value: AUD + type: String + displayName: AUD + required: false + - value: AWG + type: String + displayName: AWG + required: false + - value: AZN + type: String + displayName: AZN + required: false + - value: BBD + type: String + displayName: BBD + required: false + - value: BDT + type: String + displayName: BDT + required: false + - value: BGN + type: String + displayName: BGN + required: false + - value: BRL + type: String + displayName: BRL + required: false + - value: BWP + type: String + displayName: BWP + required: false + - value: CAD + type: String + displayName: CAD + required: false + - value: CHF + type: String + displayName: CHF + required: false + - value: CLP + type: String + displayName: CLP + required: false + - value: CNY + type: String + displayName: CNY + required: false + - value: COP + type: String + displayName: COP + required: false + - value: CRC + type: String + displayName: CRC + required: false + - value: CUC + type: String + displayName: CUC + required: false + - value: CUP + type: String + displayName: CUP + required: false + - value: CZK + type: String + displayName: CZK + required: false + - value: DKK + type: String + displayName: DKK + required: false + - value: DOP + type: String + displayName: DOP + required: false + - value: EGP + type: String + displayName: EGP + required: false + - value: EUR + type: String + displayName: EUR + required: false + - value: FJD + type: String + displayName: FJD + required: false + - value: GBP + type: String + displayName: GBP + required: false + - value: GEL + type: String + displayName: GEL + required: false + - value: GHS + type: String + displayName: GHS + required: false + - value: GTQ + type: String + displayName: GTQ + required: false + - value: GYD + type: String + displayName: GYD + required: false + - value: HKD + type: String + displayName: HKD + required: false + - value: HNL + type: String + displayName: HNL + required: false + - value: HRK + type: String + displayName: HRK + required: false + - value: HUF + type: String + displayName: HUF + required: false + - value: IDR + type: String + displayName: IDR + required: false + - value: ILS + type: String + displayName: ILS + required: false + - value: INR + type: String + displayName: INR + required: false + - value: ISK + type: String + displayName: ISK + required: false + - value: JMD + type: String + displayName: JMD + required: false + - value: JPY + type: String + displayName: JPY + required: false + - value: KES + type: String + displayName: KES + required: false + - value: KRW + type: String + displayName: KRW + required: false + - value: KWD + type: String + displayName: KWD + required: false + - value: KYD + type: String + displayName: KYD + required: false + - value: KZT + type: String + displayName: KZT + required: false + - value: LAK + type: String + displayName: LAK + required: false + - value: LBP + type: String + displayName: LBP + required: false + - value: LKR + type: String + displayName: LKR + required: false + - value: LTL + type: String + displayName: LTL + required: false + - value: LVL + type: String + displayName: LVL + required: false + - value: MAD + type: String + displayName: MAD + required: false + - value: MDL + type: String + displayName: MDL + required: false + - value: MGA + type: String + displayName: MGA + required: false + - value: MUR + type: String + displayName: MUR + required: false + - value: MVR + type: String + displayName: MVR + required: false + - value: MWK + type: String + displayName: MWK + required: false + - value: MXN + type: String + displayName: MXN + required: false + - value: MYR + type: String + displayName: MYR + required: false + - value: MZN + type: String + displayName: MZN + required: false + - value: NAD + type: String + displayName: NAD + required: false + - value: NGN + type: String + displayName: NGN + required: false + - value: NOK + type: String + displayName: NOK + required: false + - value: NPR + type: String + displayName: NPR + required: false + - value: NZD + type: String + displayName: NZD + required: false + - value: OMR + type: String + displayName: OMR + required: false + - value: PEN + type: String + displayName: PEN + required: false + - value: PHP + type: String + displayName: PHP + required: false + - value: PKR + type: String + displayName: PKR + required: false + - value: PLN + type: String + displayName: PLN + required: false + - value: QAR + type: String + displayName: QAR + required: false + - value: RON + type: String + displayName: RON + required: false + - value: RSD + type: String + displayName: RSD + required: false + - value: RUB + type: String + displayName: RUB + required: false + - value: RWF + type: String + displayName: RWF + required: false + - value: SAR + type: String + displayName: SAR + required: false + - value: SCR + type: String + displayName: SCR + required: false + - value: SEK + type: String + displayName: SEK + required: false + - value: SGD + type: String + displayName: SGD + required: false + - value: THB + type: String + displayName: THB + required: false + - value: TND + type: String + displayName: TND + required: false + - value: TRY + type: String + displayName: TRY + required: false + - value: TTD + type: String + displayName: TTD + required: false + - value: TWD + type: String + displayName: TWD + required: false + - value: TZS + type: String + displayName: TZS + required: false + - value: UAH + type: String + displayName: UAH + required: false + - value: UGX + type: String + displayName: UGX + required: false + - value: USD + type: String + displayName: USD + required: false + - value: UYU + type: String + displayName: UYU + required: false + - value: VEF + type: String + displayName: VEF + required: false + - value: VND + type: String + displayName: VND + required: false + - value: VUV + type: String + displayName: VUV + required: false + - value: XAF + type: String + displayName: XAF + required: false + - value: XCD + type: String + displayName: XCD + required: false + - value: XOF + type: String + displayName: XOF + required: false + - value: ZAR + type: String + displayName: ZAR + required: false + - value: ZMK + type: String + displayName: ZMK + required: false + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + validation: + warnings: [] + information: + - field: Balance + details: 'The opening balance, in the account currency' + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: false + required: true + KashFlow: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of the bank account as it appears in Kashflow. + required: true + balance: + type: Number + displayName: Balance + description: 'The opening balance, in the account currency.' + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account. + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: + - field: AccountName + details: Max length of 31 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + accountNumber: + type: String + displayName: Account Number + description: User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. + required: true + currency: + type: String + displayName: Currency + description: Currency of the bank account. + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: Must be provided. + - field: AccountName + details: Should not be longer than 50 characters. + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + - field: Currency + details: Must match the company's base currency. + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Should be a 6 digit number. + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + validation: + warnings: [] + information: + - field: AccountNumber + details: Should not be longer than 25 characters. + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + validation: + warnings: [] + information: + - field: IBan + details: Should be in the international bank account number format. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + required: true + Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountType: + type: String + displayName: Account Type + description: The type of account + required: true + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: true + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: true + availableBalance: + type: Number + displayName: Available Balance + description: The available balance of the bank account + required: true + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: true + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-bankAccounts-model + x-speakeasy-group: loan-writeback.bank-accounts + description: "The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create bank account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/lending-api#/operations/get-create-update-bankAccounts-model)." + operationId: create-bank-account + x-speakeasy-group: loan-writeback.bank-accounts + '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + Exact (UK): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: Name + details: Must have a length between 1 and 60 characters + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Must have a length between 1 and 255 characters + information: [] + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank + type: String + displayName: Bank + required: false + - value: Asset.AccountReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Asset.CashAndBank + type: String + displayName: Cash + required: false + - value: Asset.Property Plant and Equipment + type: String + displayName: Equipment Machinery + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherLiability + type: String + displayName: Other Liability + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Equity.Equity + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Owner's Equity + type: String + displayName: Retained Earnings + required: false + - value: Income + type: String + displayName: Income + required: false + - value: OtherIncome + type: String + displayName: Other Income + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Expense.Expense + type: String + displayName: Sales Marketing + required: false + - value: Expense.Expense.Insurance + type: String + displayName: General Administrative + required: false + - value: Expense.Overhead + type: String + displayName: General Administrative + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repairs Maintenance + required: false + - value: OtherExpense + type: String + displayName: Other Expense + required: false + - value: CostOfSales + type: String + displayName: Cost of Sales + required: false + - value: Cost Of Goods Sold.Cost of Sales + type: String + displayName: Other + required: false + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Max length of 31 characters. + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Max length of 200 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.AccountsReceivable + type: String + displayName: Account Receivable + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Income.Income + type: String + displayName: Income + required: false + - value: Income.OtherIncome + type: String + displayName: Other Income + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.CostOfGoodsSold + type: String + displayName: Cost Of Goods Sold + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.OtherExpense + type: String + displayName: Other Expense + required: false + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Should not be longer than 200 characters. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: SALES + type: String + displayName: Sales + required: false + - value: OTHER_INCOME + type: String + displayName: Other Income + required: false + - value: DIRECT_EXPENSES + type: String + displayName: Direct Expenses + required: false + - value: OVERHEADS + type: String + displayName: Overheads + required: false + - value: DEPRECIATION + type: String + displayName: Depreciation + required: false + - value: CURRENT_ASSETS + type: String + displayName: Current Assets + required: false + - value: FIXED_ASSETS + type: String + displayName: Fixed Assets + required: false + - value: FUTURE_ASSETS + type: String + displayName: Future Assets + required: false + - value: BANK + type: String + displayName: Bank + required: false + - value: CURRENT_LIABILITY + type: String + displayName: Current Liability + required: false + - value: FUTURE_LIABILITY + type: String + displayName: Future Liability + required: false + - value: EQUITY + type: String + displayName: Equity + required: false + - value: LINE_OF_CREDIT + type: String + displayName: Credit Card / Loan + required: false + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Must be unique within the entity. + - field: NominalCode + details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + options: + - value: Asset + type: String + displayName: Asset + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Income + type: String + displayName: Income + required: false + - value: Liability + type: String + displayName: Liability + required: false + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' + required: true + Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + description: + type: String + displayName: Description + description: Description of the account + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + fullyQualifiedName: + type: String + displayName: Fully Qualified Name + description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales + required: true + currency: + type: String + displayName: Currency + description: The currency of the account + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + required: true + status: + type: String + displayName: Account Status + description: The status of the account + required: true + isBankAccount: + type: Boolean + displayName: Is Bank Account? + description: Confirms whether the nominal account represents a bank account or not + required: true + validDatatypeLinks: + type: Array + displayName: Valid Datatype Links + description: Describes which fields on other data types are valid links to this account in the originating system + properties: + property: + type: String + displayName: Property + description: The field on the source data type that other data types can link to + required: true + links: + type: Array + displayName: Links + description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: Identifier for the nominal account. + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 10 characters. + information: [] + name: + type: String + displayName: Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + validation: + warnings: [] + information: + - field: Name + details: Payments are enabled to this account if the name ends in .PaymentsEnabled. + description: + type: String + displayName: Description + description: Description for the nominal account. + required: false + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: Account type and category for nominal account. + options: + - value: Asset.Current + type: String + displayName: Current Asset + required: false + - value: Asset.Fixed + type: String + displayName: Fixed Asset + required: false + - value: Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.NonCurrent + type: String + displayName: Non-current Asset + required: false + - value: Asset.Prepayment + type: String + displayName: Prepayment + required: false + - value: Expense.DirectCosts + type: String + displayName: Direct Costs + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.Overhead + type: String + displayName: Overhead + required: false + - value: Expense.Superannuation + type: String + displayName: Superannuation + required: false + - value: Expense.Wages + type: String + displayName: Wages + required: false + - value: Income.Sales + type: String + displayName: Sales + required: false + - value: Income.Revenue + type: String + displayName: Revenue + required: false + - value: Income.Other + type: String + displayName: Other Income + required: false + - value: Liability.Current + type: String + displayName: Current Liability + required: false + - value: Liability.Depreciation + type: String + displayName: Depreciation + required: false + - value: Liability.Liability + type: String + displayName: Liability + required: false + - value: Liability.NonCurrent + type: String + displayName: Non Current Liability + required: false + - value: Liability.PayAsYouGo + type: String + displayName: Pay As You Go Liability + required: false + - value: Liability.Superannuation + type: String + displayName: Superannuation Liability + required: false + - value: Liability.WagesPayable + type: String + displayName: Wages Payable Liability + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-chartOfAccounts-model + x-speakeasy-group: loan-writeback.accounts + description: |- + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create account* endpoint creates a new [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). + operationId: create-account + x-speakeasy-group: loan-writeback.accounts + '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create source account + description: |- + The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software. + + > ### Versioning + > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. + operationId: create-source-account + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' + - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + examples: + Version 2: + value: + id: acc-001 + accountName: account-081 + accountType: checking + accountNumber: '12345670' + routingInfo: + bankCode: 021001088 + type: bankcode + currency: GBP + balance: 99.99 + accountInfo: + description: account description 1 + nickname: account 123 + accountOpenDate: '2023-05-06' + availableBalance: 10 + modifiedDate: '2024-08-02T00:00:00.000Z' + Version 1: + value: + id: acc-002 + accountName: account-081 + sortCode: '123456' + accountType: Credit + accountNumber: '12345670' + currency: GBP + balance: 99.99 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + responses: + '200': + description: Success + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2' + - $ref: '#/components/schemas/SourceAccount' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + x-speakeasy-group: loan-writeback.source-accounts + '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Loan writeback + summary: List bank feed account mappings + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x61\x6E\x64\x20\x61\x6E\x79\x20\x63\x75\x72\x72\x65\x6E\x74\x20\x6F\x72\x20\x70\x6F\x74\x65\x6E\x74\x69\x61\x6C\x20\x74\x61\x72\x67\x65\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2E\n\n\x41\x20\x62\x61\x6E\x6B\x20\x66\x65\x65\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x69\x73\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x6C\x69\x6E\x6B\x20\x62\x65\x74\x77\x65\x65\x6E\x20\x74\x68\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x43\x6F\x64\x61\x74\x20\x75\x73\x65\x72\x29\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x74\x68\x65\x20\x65\x6E\x64\x20\x75\x73\x65\x72\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x6E\x64\x65\x72\x6C\x79\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x29\x2E\n\n\x3E\x20\x2A\x2A\x46\x6F\x72\x20\x63\x75\x73\x74\x6F\x6D\x20\x62\x75\x69\x6C\x64\x73\x20\x6F\x6E\x6C\x79\x2A\x2A\n\x3E\x20\n\x3E\x20\x4F\x6E\x6C\x79\x20\x75\x73\x65\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x69\x66\x20\x79\x6F\x75\x20\x61\x72\x65\x20\x62\x75\x69\x6C\x64\x69\x6E\x67\x20\x79\x6F\x75\x72\x20\x6F\x77\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x20\x55\x49\x2E" + operationId: get-bank-account-mapping + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: list-mappings + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + examples: + Example: + value: + - sourceAccountId: account-001 + status: pending + targetAccountOptions: + - name: Money Bank account + id: d21e25d6-98c5-4bfb-b469-105833bea3c8 + accountNumber: '789' + sortCode: '123456' + - name: Bank of Dave account + id: d06ff4b2-e4f2-4681-9841-014bd008cdab + accountNumber: '99887766' + sortCode: '998866' + - name: LuxLend account + id: c8f252fc-84f3-4a8b-ace8-ae99f41a81ae + accountNumber: '123456789' + sortCode: '123456' + sourceAccountName: account-001 + sourceAccountNumber: '12345670' + sourceBalance: 99.99 + sourceCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + tags: + - Loan writeback + summary: Create bank feed account mapping + description: "\uFEFF\x54\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x63\x72\x65\x61\x74\x65\x73\x20\x61\x20\x6E\x65\x77\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x62\x65\x74\x77\x65\x65\x6E\x20\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x61\x6E\x64\x20\x61\x20\x70\x6F\x74\x65\x6E\x74\x69\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x28\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x29\x2E\n\n\x41\x20\x62\x61\x6E\x6B\x20\x66\x65\x65\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x69\x73\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x6C\x69\x6E\x6B\x20\x62\x65\x74\x77\x65\x65\x6E\x20\x74\x68\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x43\x6F\x64\x61\x74\x20\x75\x73\x65\x72\x29\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x74\x68\x65\x20\x65\x6E\x64\x20\x75\x73\x65\x72\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x6E\x64\x65\x72\x6C\x79\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x29\x2E\n\n\x54\x6F\x20\x66\x69\x6E\x64\x20\x76\x61\x6C\x69\x64\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6F\x70\x74\x69\x6F\x6E\x73\x2C\x20\x66\x69\x72\x73\x74\x20\x63\x61\x6C\x6C\x20\x74\x68\x65\x20\x5B\x4C\x69\x73\x74\x20\x62\x61\x6E\x6B\x20\x66\x65\x65\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x2F\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\x73\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x62\x61\x6E\x6B\x2D\x61\x63\x63\x6F\x75\x6E\x74\x2D\x6D\x61\x70\x70\x69\x6E\x67\x29\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x2E\n\n\x3E\x20\x2A\x2A\x46\x6F\x72\x20\x63\x75\x73\x74\x6F\x6D\x20\x62\x75\x69\x6C\x64\x73\x20\x6F\x6E\x6C\x79\x2A\x2A\n\x3E\n\x3E\x20\x4F\x6E\x6C\x79\x20\x75\x73\x65\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x69\x66\x20\x79\x6F\x75\x20\x61\x72\x65\x20\x62\x75\x69\x6C\x64\x69\x6E\x67\x20\x79\x6F\x75\x72\x20\x6F\x77\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x20\x55\x49\x2E\n\n\x23\x23\x23\x23\x20\x41\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x76\x61\x72\x69\x61\x62\x69\x6C\x69\x74\x79\n\n\x54\x68\x65\x20\x6D\x65\x74\x68\x6F\x64\x20\x6F\x66\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x74\x68\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x74\x6F\x20\x74\x68\x65\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x76\x61\x72\x69\x65\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x79\x6F\x75\x72\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x75\x73\x65\x73\x2E\n\n\x23\x23\x23\x23\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x6F\x70\x74\x69\x6F\x6E\x73\x3A\n\n\x31\x2E\x20\x2A\x2A\x41\x50\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x2A\x2A\x3A\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x65\x20\x74\x68\x65\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x6A\x6F\x75\x72\x6E\x65\x79\x20\x64\x69\x72\x65\x63\x74\x6C\x79\x20\x69\x6E\x74\x6F\x20\x79\x6F\x75\x72\x20\x61\x70\x70\x6C\x69\x63\x61\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x61\x20\x73\x65\x61\x6D\x6C\x65\x73\x73\x20\x75\x73\x65\x72\x20\x65\x78\x70\x65\x72\x69\x65\x6E\x63\x65\x2E\n\x32\x2E\x20\x2A\x2A\x43\x6F\x64\x61\x74\x20\x55\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x2A\x2A\x3A\x20\x49\x66\x20\x79\x6F\x75\x20\x70\x72\x65\x66\x65\x72\x20\x61\x20\x71\x75\x69\x63\x6B\x65\x72\x20\x73\x65\x74\x75\x70\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x74\x69\x6C\x69\x7A\x65\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x75\x73\x65\x72\x20\x69\x6E\x74\x65\x72\x66\x61\x63\x65\x20\x66\x6F\x72\x20\x6D\x61\x70\x70\x69\x6E\x67\x2E\n\x33\x2E\x20\x2A\x2A\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x50\x6C\x61\x74\x66\x6F\x72\x6D\x20\x4D\x61\x70\x70\x69\x6E\x67\x2A\x2A\x3A\x20\x46\x6F\x72\x20\x73\x6F\x6D\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x2C\x20\x74\x68\x65\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x70\x72\x6F\x63\x65\x73\x73\x20\x6D\x75\x73\x74\x20\x62\x65\x20\x63\x6F\x6E\x64\x75\x63\x74\x65\x64\x20\x77\x69\x74\x68\x69\x6E\x20\x74\x68\x65\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x69\x74\x73\x65\x6C\x66\x2E\n\n\x23\x23\x23\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2D\x73\x70\x65\x63\x69\x66\x69\x63\x20\x62\x65\x68\x61\x76\x69\x6F\x72\n\n\x7C\x20\x42\x61\x6E\x6B\x20\x46\x65\x65\x64\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x7C\x20\x41\x50\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x7C\x20\x43\x6F\x64\x61\x74\x20\x55\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x7C\x20\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x50\x6C\x61\x74\x66\x6F\x72\x6D\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x7C\n\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\n\x7C\x20\x58\x65\x72\x6F\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x46\x72\x65\x65\x41\x67\x65\x6E\x74\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x4F\x72\x61\x63\x6C\x65\x20\x4E\x65\x74\x53\x75\x69\x74\x65\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x45\x78\x61\x63\x74\x20\x4F\x6E\x6C\x69\x6E\x65\x20\x28\x4E\x4C\x29\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x53\x61\x67\x65\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C" + operationId: create-bank-account-mapping + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: create-mapping + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMapping' + examples: + Example: + value: + sourceAccountId: acc-002 + targetAccountId: account-081 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMappingResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/options/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update supplier model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + Exact (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + FreeAgent: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Only one address may be specified + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must not have the part after the first name longer than 30 characters. + - field: SupplierName + details: Must not have its first part (i.e. the first name) longer than 20 characters. + information: + - field: SupplierName + details: Must be provided and must contain a First and Last name separated by a ' '(space). + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: EmailAddress + details: Must not be longer than 255 characters. + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: Phone + details: Must not be longer than 21 characters. + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: [] + information: + - field: TaxNumber + details: Must not be longer than 19 characters. + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: [] + information: + - field: RegistrationNumber + details: Must not be longer than 14 characters. + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + required: false + - value: Unknown + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line1 + details: Must not be longer than 127 characters. + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line2 + details: Must not be longer than 127 characters. + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: [] + information: + - field: Addresses.City + details: Must not be longer than 255 characters. + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: [] + information: + - field: Addresses.Region + details: Must not be longer than 255 characters. + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.PostalCode + details: Must not be longer than 11 characters. + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Country + details: Must not be longer than 255 characters. + required: true + validation: + warnings: + - field: Addresses + details: Must only have 5 address entries at most. + information: + - field: Addresses + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing + required: false + - value: Delivery + type: String + displayName: Delivery + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: true + validation: + warnings: + - field: Addresses.Country + details: Must be a two letter Country ISO code + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: + - field: Addresses + details: Only one each of Billing and Delivery addresses can be provided + information: + - field: Addresses + details: Multiple addresses of Unknown type may be provided + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Max length of 41 characters. + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + validation: + warnings: + - field: ContactName + details: Max length of 25 characters for first and last names + information: [] + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Max length of 30 characters. + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + validation: + warnings: + - field: DefaultCurrency + details: 'Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company' + - field: DefaultCurrency + details: Can only be set if Multicurrency is enabled within the QuickBooks Desktop company + information: + - field: DefaultCurrency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 41 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 41 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 31 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 21 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 31 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Max length of 13 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: [] + information: + - field: Addresses.Type + details: Only 1 address each of type(s) Billing/Delivery may be specified. + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + id: + type: String + displayName: Id + description: ID of the supplier. + required: true + validation: + warnings: + - field: id + details: 'The supplier ID must be unique, contain no spaces and have a maximum of 8 characters.' + information: + - field: id + details: 'The supplier ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing.' + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + validation: + warnings: + - field: supplierName + details: The supplier name can have a maximum of 60 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier. + required: false + validation: + warnings: + - field: contactName + details: The contact name can have a maximum of 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The email address that the supplier may be contacted on. + required: false + phone: + type: String + displayName: Telephone + description: The telephone number that the supplier may be contacted on. + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: 'If not provided, the currency will default to the company''s base currency.' + required: false + status: + type: String + displayName: Status + description: The status of the supplier. + options: + - value: Active + type: String + displayName: Active Status + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Line 1 + description: Line 1 of the supplier address. + required: true + line2: + type: String + displayName: Line 2 + description: Line 2 of the supplier address. + required: false + city: + type: String + displayName: City + description: The city of the supplier address. + required: false + region: + type: String + displayName: Region + description: The region of the supplier address. + required: false + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Unknown + type: String + displayName: Unknown Address + required: false + required: false + validation: + warnings: [] + information: + - field: addresses.type + details: 'If Address type is not specified, it will default to type ''''Unknown''''' + required: false + validation: + warnings: + - field: addresses + details: Only one address can be included in the Addresses array. + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal company registration identifier. + required: false + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + validation: + warnings: + - field: Addresses.Line1 + details: 'If you''re adding an address for this Supplier, you must also include the first line' + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + country: + type: String + displayName: Country + description: The country for the address + options: + - value: Afghanistan (AF) + type: String + displayName: Afghanistan (AF) + required: false + - value: Albania (AL) + type: String + displayName: Albania (AL) + required: false + - value: Algeria (DZ) + type: String + displayName: Algeria (DZ) + required: false + - value: Andorra (AD) + type: String + displayName: Andorra (AD) + required: false + - value: Angola (AO) + type: String + displayName: Angola (AO) + required: false + - value: Argentina (AR) + type: String + displayName: Argentina (AR) + required: false + - value: Armenia (AM) + type: String + displayName: Armenia (AM) + required: false + - value: Aruba (AW) + type: String + displayName: Aruba (AW) + required: false + - value: Australia (AU) + type: String + displayName: Australia (AU) + required: false + - value: Austria (AT) + type: String + displayName: Austria (AT) + required: false + - value: Azerbaijan (AZ) + type: String + displayName: Azerbaijan (AZ) + required: false + - value: Bahamas (BS) + type: String + displayName: Bahamas (BS) + required: false + - value: Bahrain (BH) + type: String + displayName: Bahrain (BH) + required: false + - value: Bangladesh (BD) + type: String + displayName: Bangladesh (BD) + required: false + - value: Barbados (BB) + type: String + displayName: Barbados (BB) + required: false + - value: Belarus (BY) + type: String + displayName: Belarus (BY) + required: false + - value: Belgium (BE) + type: String + displayName: Belgium (BE) + required: false + - value: Belize (BZ) + type: String + displayName: Belize (BZ) + required: false + - value: Benin (BJ) + type: String + displayName: Benin (BJ) + required: false + - value: Bermuda (BM) + type: String + displayName: Bermuda (BM) + required: false + - value: Bhutan (BT) + type: String + displayName: Bhutan (BT) + required: false + - value: Bolivia (BO) + type: String + displayName: Bolivia (BO) + required: false + - value: Bosnia and Herzegovina (BA) + type: String + displayName: Bosnia and Herzegovina (BA) + required: false + - value: Botswana (BW) + type: String + displayName: Botswana (BW) + required: false + - value: Brazil (BR) + type: String + displayName: Brazil (BR) + required: false + - value: British Virgin Islands (VG) + type: String + displayName: British Virgin Islands (VG) + required: false + - value: Brunei Darussalam (BN) + type: String + displayName: Brunei Darussalam (BN) + required: false + - value: Bulgaria (BG) + type: String + displayName: Bulgaria (BG) + required: false + - value: Burkina Faso (BF) + type: String + displayName: Burkina Faso (BF) + required: false + - value: Burundi (BI) + type: String + displayName: Burundi (BI) + required: false + - value: Cambodia (KH) + type: String + displayName: Cambodia (KH) + required: false + - value: Cameroon (CM) + type: String + displayName: Cameroon (CM) + required: false + - value: Canada (CA) + type: String + displayName: Canada (CA) + required: false + - value: Cape Verde (CV) + type: String + displayName: Cape Verde (CV) + required: false + - value: Cayman Islands (KY) + type: String + displayName: Cayman Islands (KY) + required: false + - value: Central African Republic (CF) + type: String + displayName: Central African Republic (CF) + required: false + - value: Chad (TD) + type: String + displayName: Chad (TD) + required: false + - value: Chile (CL) + type: String + displayName: Chile (CL) + required: false + - value: China (CN) + type: String + displayName: China (CN) + required: false + - value: Colombia (CO) + type: String + displayName: Colombia (CO) + required: false + - value: Comoros (KM) + type: String + displayName: Comoros (KM) + required: false + - value: Congo (CG) + type: String + displayName: Congo (CG) + required: false + - value: Costa Rica (CR) + type: String + displayName: Costa Rica (CR) + required: false + - value: Croatia (HR) + type: String + displayName: Croatia (HR) + required: false + - value: Cuba (CU) + type: String + displayName: Cuba (CU) + required: false + - value: Cura�ao (CW) + type: String + displayName: Cura�ao (CW) + required: false + - value: Cyprus (CY) + type: String + displayName: Cyprus (CY) + required: false + - value: Czech Republic (CZ) + type: String + displayName: Czech Republic (CZ) + required: false + - value: Democratic Republic of the Congo (CD) + type: String + displayName: Democratic Republic of the Congo (CD) + required: false + - value: Denmark (DK) + type: String + displayName: Denmark (DK) + required: false + - value: Djibouti (DJ) + type: String + displayName: Djibouti (DJ) + required: false + - value: Dominica (DM) + type: String + displayName: Dominica (DM) + required: false + - value: Dominican Republic (DO) + type: String + displayName: Dominican Republic (DO) + required: false + - value: East Timor (TP) + type: String + displayName: East Timor (TP) + required: false + - value: Ecuador (EC) + type: String + displayName: Ecuador (EC) + required: false + - value: Egypt (EG) + type: String + displayName: Egypt (EG) + required: false + - value: El Salvador (SV) + type: String + displayName: El Salvador (SV) + required: false + - value: Equatorial Guinea (GQ) + type: String + displayName: Equatorial Guinea (GQ) + required: false + - value: Eritrea (ER) + type: String + displayName: Eritrea (ER) + required: false + - value: Estonia (EE) + type: String + displayName: Estonia (EE) + required: false + - value: Ethiopia (ET) + type: String + displayName: Ethiopia (ET) + required: false + - value: Falkland Islands (Malvinas) (FK) + type: String + displayName: Falkland Islands (Malvinas) (FK) + required: false + - value: Federated States of Micronesia (FM) + type: String + displayName: Federated States of Micronesia (FM) + required: false + - value: Fiji (FJ) + type: String + displayName: Fiji (FJ) + required: false + - value: Finland (FI) + type: String + displayName: Finland (FI) + required: false + - value: France (FR) + type: String + displayName: France (FR) + required: false + - value: French Polynesia (PF) + type: String + displayName: French Polynesia (PF) + required: false + - value: Gabon (GA) + type: String + displayName: Gabon (GA) + required: false + - value: Gambia (GM) + type: String + displayName: Gambia (GM) + required: false + - value: Georgia (GE) + type: String + displayName: Georgia (GE) + required: false + - value: Germany (DE) + type: String + displayName: Germany (DE) + required: false + - value: Ghana (GH) + type: String + displayName: Ghana (GH) + required: false + - value: Gibraltar (GI) + type: String + displayName: Gibraltar (GI) + required: false + - value: Greece (GR) + type: String + displayName: Greece (GR) + required: false + - value: Greenland (GL) + type: String + displayName: Greenland (GL) + required: false + - value: Grenada (GD) + type: String + displayName: Grenada (GD) + required: false + - value: Guadaloupe (GP) + type: String + displayName: Guadaloupe (GP) + required: false + - value: Guam (GU) + type: String + displayName: Guam (GU) + required: false + - value: Guatemala (GT) + type: String + displayName: Guatemala (GT) + required: false + - value: Guernsey (GG) + type: String + displayName: Guernsey (GG) + required: false + - value: Guinea (GN) + type: String + displayName: Guinea (GN) + required: false + - value: Guinea-Bissau (GW) + type: String + displayName: Guinea-Bissau (GW) + required: false + - value: Guyana (GY) + type: String + displayName: Guyana (GY) + required: false + - value: Haiti (HT) + type: String + displayName: Haiti (HT) + required: false + - value: Honduras (HN) + type: String + displayName: Honduras (HN) + required: false + - value: Hong Kong (HK) + type: String + displayName: Hong Kong (HK) + required: false + - value: Hungary (HU) + type: String + displayName: Hungary (HU) + required: false + - value: Iceland (IS) + type: String + displayName: Iceland (IS) + required: false + - value: India (IN) + type: String + displayName: India (IN) + required: false + - value: Indonesia (ID) + type: String + displayName: Indonesia (ID) + required: false + - value: Iran (IR) + type: String + displayName: Iran (IR) + required: false + - value: Iraq (IQ) + type: String + displayName: Iraq (IQ) + required: false + - value: Ireland (IE) + type: String + displayName: Ireland (IE) + required: false + - value: Israel (IL) + type: String + displayName: Israel (IL) + required: false + - value: Italy (IT) + type: String + displayName: Italy (IT) + required: false + - value: Ivory Coast (CI) + type: String + displayName: Ivory Coast (CI) + required: false + - value: Jamaica (JM) + type: String + displayName: Jamaica (JM) + required: false + - value: Japan (JP) + type: String + displayName: Japan (JP) + required: false + - value: Jersey (JE) + type: String + displayName: Jersey (JE) + required: false + - value: Jordan (JO) + type: String + displayName: Jordan (JO) + required: false + - value: Kazakhstan (KZ) + type: String + displayName: Kazakhstan (KZ) + required: false + - value: Kenya (KE) + type: String + displayName: Kenya (KE) + required: false + - value: Kuwait (KW) + type: String + displayName: Kuwait (KW) + required: false + - value: Kyrgyzstan (KG) + type: String + displayName: Kyrgyzstan (KG) + required: false + - value: Laos (LA) + type: String + displayName: Laos (LA) + required: false + - value: Latvia (LV) + type: String + displayName: Latvia (LV) + required: false + - value: Lebanon (LB) + type: String + displayName: Lebanon (LB) + required: false + - value: Lesotho (LS) + type: String + displayName: Lesotho (LS) + required: false + - value: Liberia (LR) + type: String + displayName: Liberia (LR) + required: false + - value: Libya (LY) + type: String + displayName: Libya (LY) + required: false + - value: Liechtenstein (LI) + type: String + displayName: Liechtenstein (LI) + required: false + - value: Lithuania (LT) + type: String + displayName: Lithuania (LT) + required: false + - value: Luxembourg (LU) + type: String + displayName: Luxembourg (LU) + required: false + - value: Macau (MO) + type: String + displayName: Macau (MO) + required: false + - value: Macedonia (MK) + type: String + displayName: Macedonia (MK) + required: false + - value: Madagascar (MG) + type: String + displayName: Madagascar (MG) + required: false + - value: Malawi (MW) + type: String + displayName: Malawi (MW) + required: false + - value: Malaysia (MY) + type: String + displayName: Malaysia (MY) + required: false + - value: Maldives (MV) + type: String + displayName: Maldives (MV) + required: false + - value: Mali (ML) + type: String + displayName: Mali (ML) + required: false + - value: Malta (MT) + type: String + displayName: Malta (MT) + required: false + - value: Mauritania (MR) + type: String + displayName: Mauritania (MR) + required: false + - value: Mauritius (MU) + type: String + displayName: Mauritius (MU) + required: false + - value: Mexico (MX) + type: String + displayName: Mexico (MX) + required: false + - value: Moldova (MD) + type: String + displayName: Moldova (MD) + required: false + - value: Monaco (MC) + type: String + displayName: Monaco (MC) + required: false + - value: Mongolia (MN) + type: String + displayName: Mongolia (MN) + required: false + - value: Montenegro (ME) + type: String + displayName: Montenegro (ME) + required: false + - value: Morocco (MA) + type: String + displayName: Morocco (MA) + required: false + - value: Mozambique (MZ) + type: String + displayName: Mozambique (MZ) + required: false + - value: Myanmar (MM) + type: String + displayName: Myanmar (MM) + required: false + - value: Namibia (NA) + type: String + displayName: Namibia (NA) + required: false + - value: Nepal (NP) + type: String + displayName: Nepal (NP) + required: false + - value: Netherlands (NL) + type: String + displayName: Netherlands (NL) + required: false + - value: Netherlands Antilles (AN) + type: String + displayName: Netherlands Antilles (AN) + required: false + - value: New Caledonia (NC) + type: String + displayName: New Caledonia (NC) + required: false + - value: New Zealand (NZ) + type: String + displayName: New Zealand (NZ) + required: false + - value: Nicaragua (NI) + type: String + displayName: Nicaragua (NI) + required: false + - value: Niger (NE) + type: String + displayName: Niger (NE) + required: false + - value: Nigeria (NG) + type: String + displayName: Nigeria (NG) + required: false + - value: North Korea (KP) + type: String + displayName: North Korea (KP) + required: false + - value: Norway (NO) + type: String + displayName: Norway (NO) + required: false + - value: Oman (OM) + type: String + displayName: Oman (OM) + required: false + - value: Pakistan (PK) + type: String + displayName: Pakistan (PK) + required: false + - value: Panama (PA) + type: String + displayName: Panama (PA) + required: false + - value: Papua New Guinea (PG) + type: String + displayName: Papua New Guinea (PG) + required: false + - value: Paraguay (PY) + type: String + displayName: Paraguay (PY) + required: false + - value: Peru (PE) + type: String + displayName: Peru (PE) + required: false + - value: Philippines (PH) + type: String + displayName: Philippines (PH) + required: false + - value: Poland (PL) + type: String + displayName: Poland (PL) + required: false + - value: Portugal (PT) + type: String + displayName: Portugal (PT) + required: false + - value: Puerto Rico (PR) + type: String + displayName: Puerto Rico (PR) + required: false + - value: Qatar (QA) + type: String + displayName: Qatar (QA) + required: false + - value: Romania (RO) + type: String + displayName: Romania (RO) + required: false + - value: Russia (RU) + type: String + displayName: Russia (RU) + required: false + - value: Rwanda (RW) + type: String + displayName: Rwanda (RW) + required: false + - value: Saint Kitts and Nevis (KN) + type: String + displayName: Saint Kitts and Nevis (KN) + required: false + - value: Saint Pierre and Miquelon (PM) + type: String + displayName: Saint Pierre and Miquelon (PM) + required: false + - value: Samoa (WS) + type: String + displayName: Samoa (WS) + required: false + - value: San Marino (SM) + type: String + displayName: San Marino (SM) + required: false + - value: Sao Tome and Principe (ST) + type: String + displayName: Sao Tome and Principe (ST) + required: false + - value: Saudi Arabia (SA) + type: String + displayName: Saudi Arabia (SA) + required: false + - value: Senegal (SN) + type: String + displayName: Senegal (SN) + required: false + - value: Serbia (RS) + type: String + displayName: Serbia (RS) + required: false + - value: Seychelles (SC) + type: String + displayName: Seychelles (SC) + required: false + - value: Sierra Leone (SL) + type: String + displayName: Sierra Leone (SL) + required: false + - value: Singapore (SG) + type: String + displayName: Singapore (SG) + required: false + - value: Slovakia (SK) + type: String + displayName: Slovakia (SK) + required: false + - value: Slovenia (SI) + type: String + displayName: Slovenia (SI) + required: false + - value: Solomon Islands (SB) + type: String + displayName: Solomon Islands (SB) + required: false + - value: Somalia (SO) + type: String + displayName: Somalia (SO) + required: false + - value: South Africa (ZA) + type: String + displayName: South Africa (ZA) + required: false + - value: South Korea (KR) + type: String + displayName: South Korea (KR) + required: false + - value: Spain (ES) + type: String + displayName: Spain (ES) + required: false + - value: Sri Lanka (LK) + type: String + displayName: Sri Lanka (LK) + required: false + - value: St. Lucia (LC) + type: String + displayName: St. Lucia (LC) + required: false + - value: Sudan (SD) + type: String + displayName: Sudan (SD) + required: false + - value: Surinam (SR) + type: String + displayName: Surinam (SR) + required: false + - value: Swaziland (SZ) + type: String + displayName: Swaziland (SZ) + required: false + - value: Sweden (SE) + type: String + displayName: Sweden (SE) + required: false + - value: Switzerland (CH) + type: String + displayName: Switzerland (CH) + required: false + - value: Syria (SY) + type: String + displayName: Syria (SY) + required: false + - value: Taiwan (TW) + type: String + displayName: Taiwan (TW) + required: false + - value: Tajikistan (TJ) + type: String + displayName: Tajikistan (TJ) + required: false + - value: Tanzania (TZ) + type: String + displayName: Tanzania (TZ) + required: false + - value: Thailand (TH) + type: String + displayName: Thailand (TH) + required: false + - value: Togo (TG) + type: String + displayName: Togo (TG) + required: false + - value: Tonga (TO) + type: String + displayName: Tonga (TO) + required: false + - value: Trinidad and Tobago (TT) + type: String + displayName: Trinidad and Tobago (TT) + required: false + - value: Tunisia (TN) + type: String + displayName: Tunisia (TN) + required: false + - value: Turkey (TR) + type: String + displayName: Turkey (TR) + required: false + - value: Turkmenistan (TM) + type: String + displayName: Turkmenistan (TM) + required: false + - value: Tuvalu (TV) + type: String + displayName: Tuvalu (TV) + required: false + - value: Uganda (UG) + type: String + displayName: Uganda (UG) + required: false + - value: Ukraine (UA) + type: String + displayName: Ukraine (UA) + required: false + - value: United Arab Emirates (AE) + type: String + displayName: United Arab Emirates (AE) + required: false + - value: United Kingdom (GB) + type: String + displayName: United Kingdom (GB) + required: false + - value: United States (US) + type: String + displayName: United States (US) + required: false + - value: Uruguay (UY) + type: String + displayName: Uruguay (UY) + required: false + - value: Uzbekistan (UZ) + type: String + displayName: Uzbekistan (UZ) + required: false + - value: Vanuatu (VU) + type: String + displayName: Vanuatu (VU) + required: false + - value: Venezuela (VE) + type: String + displayName: Venezuela (VE) + required: false + - value: Vietnam (VN) + type: String + displayName: Vietnam (VN) + required: false + - value: Virgin Islands U.S. (VI) + type: String + displayName: Virgin Islands U.S. (VI) + required: false + - value: Western Sahara (EH) + type: String + displayName: Western Sahara (EH) + required: false + - value: Yemen (YE) + type: String + displayName: Yemen (YE) + required: false + - value: Zaire (ZR) + type: String + displayName: Zaire (ZR) + required: false + - value: Zambia (ZM) + type: String + displayName: Zambia (ZM) + required: false + - value: Zimbabwe (ZW) + type: String + displayName: Zimbabwe (ZW) + required: false + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Can contain a maximum of one address + required: true + Sage Intacct: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must be between 1 and 100 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + validation: + warnings: + - field: ContactName + details: Must be between 1 and 200 characters + information: [] + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: Must be no greater than 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: + - field: EmailAddress + details: Must be no greater than 200 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Must be no greater than 20 characters + information: [] + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: Must be no greater than 100 characters + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + - value: CAD + type: String + displayName: Canadian Dollar + required: false + - value: GBP + type: String + displayName: Pound Sterling + required: false + - value: USD + type: String + displayName: US Dollar + required: false + - value: ZAR + type: String + displayName: Rand + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Must be no greater than 200 characters + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Must be no greater than 200 characters + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Must be no greater than 80 characters + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Must be no greater than 40 characters + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Must be no greater than 30 characters + information: [] + country: + type: String + displayName: Country + description: The country for the address + options: + - value: United States + type: String + displayName: United States + required: false + - value: Afghanistan + type: String + displayName: Afghanistan + required: false + - value: Aland Islands + type: String + displayName: Aland Islands + required: false + - value: Albania + type: String + displayName: Albania + required: false + - value: Algeria + type: String + displayName: Algeria + required: false + - value: American Samoa + type: String + displayName: American Samoa + required: false + - value: Andorra + type: String + displayName: Andorra + required: false + - value: Angola + type: String + displayName: Angola + required: false + - value: Anguilla + type: String + displayName: Anguilla + required: false + - value: Antarctica + type: String + displayName: Antarctica + required: false + - value: Antigua and Barbuda + type: String + displayName: Antigua and Barbuda + required: false + - value: Argentina + type: String + displayName: Argentina + required: false + - value: Armenia + type: String + displayName: Armenia + required: false + - value: Aruba + type: String + displayName: Aruba + required: false + - value: Australia + type: String + displayName: Australia + required: false + - value: Austria + type: String + displayName: Austria + required: false + - value: Azerbaijan + type: String + displayName: Azerbaijan + required: false + - value: Bahamas + type: String + displayName: Bahamas + required: false + - value: Bahrain + type: String + displayName: Bahrain + required: false + - value: Bangladesh + type: String + displayName: Bangladesh + required: false + - value: Barbados + type: String + displayName: Barbados + required: false + - value: Belarus + type: String + displayName: Belarus + required: false + - value: Belgium + type: String + displayName: Belgium + required: false + - value: Belize + type: String + displayName: Belize + required: false + - value: Benin + type: String + displayName: Benin + required: false + - value: Bermuda + type: String + displayName: Bermuda + required: false + - value: Bhutan + type: String + displayName: Bhutan + required: false + - value: Bolivia + type: String + displayName: Bolivia + required: false + - value: 'Bonaire, Sint Eustatius and Saba' + type: String + displayName: 'Bonaire, Sint Eustatius and Saba' + required: false + - value: Bosnia and Herzegovina + type: String + displayName: Bosnia and Herzegovina + required: false + - value: Botswana + type: String + displayName: Botswana + required: false + - value: Bouvet Island + type: String + displayName: Bouvet Island + required: false + - value: Brazil + type: String + displayName: Brazil + required: false + - value: British Indian Ocean Territory + type: String + displayName: British Indian Ocean Territory + required: false + - value: Brunei Darussalam + type: String + displayName: Brunei Darussalam + required: false + - value: Bulgaria + type: String + displayName: Bulgaria + required: false + - value: Burkina Faso + type: String + displayName: Burkina Faso + required: false + - value: Burundi + type: String + displayName: Burundi + required: false + - value: Cambodia + type: String + displayName: Cambodia + required: false + - value: Cameroon + type: String + displayName: Cameroon + required: false + - value: Canada + type: String + displayName: Canada + required: false + - value: Cape Verde + type: String + displayName: Cape Verde + required: false + - value: Cayman Islands + type: String + displayName: Cayman Islands + required: false + - value: Central African Republic + type: String + displayName: Central African Republic + required: false + - value: Chad + type: String + displayName: Chad + required: false + - value: Chile + type: String + displayName: Chile + required: false + - value: China + type: String + displayName: China + required: false + - value: Christmas Island + type: String + displayName: Christmas Island + required: false + - value: Cocos (Keeling) Islands + type: String + displayName: Cocos (Keeling) Islands + required: false + - value: Colombia + type: String + displayName: Colombia + required: false + - value: Comoros + type: String + displayName: Comoros + required: false + - value: Congo + type: String + displayName: Congo + required: false + - value: 'Congo, Democratic Republic' + type: String + displayName: 'Congo, Democratic Republic' + required: false + - value: Cook Islands + type: String + displayName: Cook Islands + required: false + - value: Costa Rica + type: String + displayName: Costa Rica + required: false + - value: C�te d'Ivoire + type: String + displayName: C�te d'Ivoire + required: false + - value: Croatia + type: String + displayName: Croatia + required: false + - value: Cuba + type: String + displayName: Cuba + required: false + - value: Cura�ao + type: String + displayName: Cura�ao + required: false + - value: Cyprus + type: String + displayName: Cyprus + required: false + - value: Czech Republic + type: String + displayName: Czech Republic + required: false + - value: Denmark + type: String + displayName: Denmark + required: false + - value: Djibouti + type: String + displayName: Djibouti + required: false + - value: Dominica + type: String + displayName: Dominica + required: false + - value: Dominican Republic + type: String + displayName: Dominican Republic + required: false + - value: Ecuador + type: String + displayName: Ecuador + required: false + - value: Egypt + type: String + displayName: Egypt + required: false + - value: El Salvador + type: String + displayName: El Salvador + required: false + - value: Equatorial Guinea + type: String + displayName: Equatorial Guinea + required: false + - value: Eritrea + type: String + displayName: Eritrea + required: false + - value: Estonia + type: String + displayName: Estonia + required: false + - value: Eswatini + type: String + displayName: Eswatini + required: false + - value: Ethiopia + type: String + displayName: Ethiopia + required: false + - value: Falkland Islands (Malvinas + type: String + displayName: Falkland Islands (Malvinas + required: false + - value: Faroe Islands + type: String + displayName: Faroe Islands + required: false + - value: Fiji + type: String + displayName: Fiji + required: false + - value: Finland + type: String + displayName: Finland + required: false + - value: France + type: String + displayName: France + required: false + - value: French Guiana + type: String + displayName: French Guiana + required: false + - value: French Polynesia + type: String + displayName: French Polynesia + required: false + - value: French Southern Territories + type: String + displayName: French Southern Territories + required: false + - value: Gabon + type: String + displayName: Gabon + required: false + - value: Gambia + type: String + displayName: Gambia + required: false + - value: Georgia + type: String + displayName: Georgia + required: false + - value: Germany + type: String + displayName: Germany + required: false + - value: Ghana + type: String + displayName: Ghana + required: false + - value: Gibraltar + type: String + displayName: Gibraltar + required: false + - value: Greece + type: String + displayName: Greece + required: false + - value: Greenland + type: String + displayName: Greenland + required: false + - value: Grenada + type: String + displayName: Grenada + required: false + - value: Guadeloupe + type: String + displayName: Guadeloupe + required: false + - value: Guam + type: String + displayName: Guam + required: false + - value: Guatemala + type: String + displayName: Guatemala + required: false + - value: Guernsey + type: String + displayName: Guernsey + required: false + - value: Guinea + type: String + displayName: Guinea + required: false + - value: Guinea-Bissau + type: String + displayName: Guinea-Bissau + required: false + - value: Guyana + type: String + displayName: Guyana + required: false + - value: Haiti + type: String + displayName: Haiti + required: false + - value: Heard Is. & Mcdonald Islands + type: String + displayName: Heard Is. & Mcdonald Islands + required: false + - value: Honduras + type: String + displayName: Honduras + required: false + - value: Hong Kong + type: String + displayName: Hong Kong + required: false + - value: Hungary + type: String + displayName: Hungary + required: false + - value: Iceland + type: String + displayName: Iceland + required: false + - value: India + type: String + displayName: India + required: false + - value: Indonesia + type: String + displayName: Indonesia + required: false + - value: 'Iran, Islamic Republic of' + type: String + displayName: 'Iran, Islamic Republic of' + required: false + - value: Iraq + type: String + displayName: Iraq + required: false + - value: Ireland + type: String + displayName: Ireland + required: false + - value: Isle of Man + type: String + displayName: Isle of Man + required: false + - value: Israel + type: String + displayName: Israel + required: false + - value: Italy + type: String + displayName: Italy + required: false + - value: Jamaica + type: String + displayName: Jamaica + required: false + - value: Japan + type: String + displayName: Japan + required: false + - value: Jersey + type: String + displayName: Jersey + required: false + - value: Jordan + type: String + displayName: Jordan + required: false + - value: Kazakhstan + type: String + displayName: Kazakhstan + required: false + - value: Kenya + type: String + displayName: Kenya + required: false + - value: Kiribati + type: String + displayName: Kiribati + required: false + - value: 'Korea, Republic of' + type: String + displayName: 'Korea, Republic of' + required: false + - value: 'Korea, Demo. People''s Rep' + type: String + displayName: 'Korea, Demo. People''s Rep' + required: false + - value: Kosovo + type: String + displayName: Kosovo + required: false + - value: Kuwait + type: String + displayName: Kuwait + required: false + - value: Kyrgyzstan + type: String + displayName: Kyrgyzstan + required: false + - value: Lao + type: String + displayName: Lao + required: false + - value: Latvia + type: String + displayName: Latvia + required: false + - value: Lebanon + type: String + displayName: Lebanon + required: false + - value: Lesotho + type: String + displayName: Lesotho + required: false + - value: Liberia + type: String + displayName: Liberia + required: false + - value: Libyan Arab Jamahiriya + type: String + displayName: Libyan Arab Jamahiriya + required: false + - value: Liechtenstein + type: String + displayName: Liechtenstein + required: false + - value: Lithuania + type: String + displayName: Lithuania + required: false + - value: Luxembourg + type: String + displayName: Luxembourg + required: false + - value: Macao + type: String + displayName: Macao + required: false + - value: Macedonia + type: String + displayName: Macedonia + required: false + - value: Madagascar + type: String + displayName: Madagascar + required: false + - value: Malawi + type: String + displayName: Malawi + required: false + - value: Malaysia + type: String + displayName: Malaysia + required: false + - value: Maldives + type: String + displayName: Maldives + required: false + - value: Mali + type: String + displayName: Mali + required: false + - value: Malta + type: String + displayName: Malta + required: false + - value: Marshall Islands + type: String + displayName: Marshall Islands + required: false + - value: Martinique + type: String + displayName: Martinique + required: false + - value: Mauritania + type: String + displayName: Mauritania + required: false + - value: Mauritius + type: String + displayName: Mauritius + required: false + - value: Mayotte + type: String + displayName: Mayotte + required: false + - value: Mexico + type: String + displayName: Mexico + required: false + - value: Micronesia + type: String + displayName: Micronesia + required: false + - value: 'Moldova, Republic of' + type: String + displayName: 'Moldova, Republic of' + required: false + - value: Monaco + type: String + displayName: Monaco + required: false + - value: Mongolia + type: String + displayName: Mongolia + required: false + - value: Montenegro + type: String + displayName: Montenegro + required: false + - value: Montserrat + type: String + displayName: Montserrat + required: false + - value: Morocco + type: String + displayName: Morocco + required: false + - value: Mozambique + type: String + displayName: Mozambique + required: false + - value: Myanmar + type: String + displayName: Myanmar + required: false + - value: Namibia + type: String + displayName: Namibia + required: false + - value: Nauru + type: String + displayName: Nauru + required: false + - value: Nepal + type: String + displayName: Nepal + required: false + - value: Netherlands + type: String + displayName: Netherlands + required: false + - value: Netherlands Antilles + type: String + displayName: Netherlands Antilles + required: false + - value: New Caledonia + type: String + displayName: New Caledonia + required: false + - value: New Zealand + type: String + displayName: New Zealand + required: false + - value: Nicaragua + type: String + displayName: Nicaragua + required: false + - value: Niger + type: String + displayName: Niger + required: false + - value: Nigeria + type: String + displayName: Nigeria + required: false + - value: Niue + type: String + displayName: Niue + required: false + - value: Norfolk Island + type: String + displayName: Norfolk Island + required: false + - value: Northern Mariana Islands + type: String + displayName: Northern Mariana Islands + required: false + - value: Norway + type: String + displayName: Norway + required: false + - value: Oman + type: String + displayName: Oman + required: false + - value: Pakistan + type: String + displayName: Pakistan + required: false + - value: Palau + type: String + displayName: Palau + required: false + - value: 'Palestinian Territory, Occupied' + type: String + displayName: 'Palestinian Territory, Occupied' + required: false + - value: Panama + type: String + displayName: Panama + required: false + - value: Papua New Guinea + type: String + displayName: Papua New Guinea + required: false + - value: Paraguay + type: String + displayName: Paraguay + required: false + - value: Peru + type: String + displayName: Peru + required: false + - value: Philippines + type: String + displayName: Philippines + required: false + - value: Pitcairn + type: String + displayName: Pitcairn + required: false + - value: Poland + type: String + displayName: Poland + required: false + - value: Portugal + type: String + displayName: Portugal + required: false + - value: Puerto Rico + type: String + displayName: Puerto Rico + required: false + - value: Qatar + type: String + displayName: Qatar + required: false + - value: Reunion + type: String + displayName: Reunion + required: false + - value: Romania + type: String + displayName: Romania + required: false + - value: Russian Federation + type: String + displayName: Russian Federation + required: false + - value: Rwanda + type: String + displayName: Rwanda + required: false + - value: Saint Barthelemy + type: String + displayName: Saint Barthelemy + required: false + - value: Saint Helena + type: String + displayName: Saint Helena + required: false + - value: Saint Kitts and Nevis + type: String + displayName: Saint Kitts and Nevis + required: false + - value: Saint Lucia + type: String + displayName: Saint Lucia + required: false + - value: Saint Martin + type: String + displayName: Saint Martin + required: false + - value: Saint Pierre and Miquelon + type: String + displayName: Saint Pierre and Miquelon + required: false + - value: Saint Vincent and the Grenadines + type: String + displayName: Saint Vincent and the Grenadines + required: false + - value: Samoa + type: String + displayName: Samoa + required: false + - value: San Marino + type: String + displayName: San Marino + required: false + - value: Sao Tome and Principe + type: String + displayName: Sao Tome and Principe + required: false + - value: Saudi Arabia + type: String + displayName: Saudi Arabia + required: false + - value: Senegal + type: String + displayName: Senegal + required: false + - value: Serbia + type: String + displayName: Serbia + required: false + - value: Seychelles + type: String + displayName: Seychelles + required: false + - value: Sierra Leone + type: String + displayName: Sierra Leone + required: false + - value: Singapore + type: String + displayName: Singapore + required: false + - value: Sint Maarten + type: String + displayName: Sint Maarten + required: false + - value: Slovakia + type: String + displayName: Slovakia + required: false + - value: Slovenia + type: String + displayName: Slovenia + required: false + - value: Solomon Islands + type: String + displayName: Solomon Islands + required: false + - value: Somalia + type: String + displayName: Somalia + required: false + - value: South Africa + type: String + displayName: South Africa + required: false + - value: S. Georgia & S. Sandwich Is + type: String + displayName: S. Georgia & S. Sandwich Is + required: false + - value: Spain + type: String + displayName: Spain + required: false + - value: Sri Lanka + type: String + displayName: Sri Lanka + required: false + - value: Sudan + type: String + displayName: Sudan + required: false + - value: South Sudan + type: String + displayName: South Sudan + required: false + - value: Suriname + type: String + displayName: Suriname + required: false + - value: Svalbard and Jan Mayen + type: String + displayName: Svalbard and Jan Mayen + required: false + - value: Sweden + type: String + displayName: Sweden + required: false + - value: Switzerland + type: String + displayName: Switzerland + required: false + - value: Syrian Arab Republic + type: String + displayName: Syrian Arab Republic + required: false + - value: Taiwan + type: String + displayName: Taiwan + required: false + - value: Tajikistan + type: String + displayName: Tajikistan + required: false + - value: 'Tanzania, United Republic of' + type: String + displayName: 'Tanzania, United Republic of' + required: false + - value: Thailand + type: String + displayName: Thailand + required: false + - value: Timor-Leste + type: String + displayName: Timor-Leste + required: false + - value: Togo + type: String + displayName: Togo + required: false + - value: Tokelau + type: String + displayName: Tokelau + required: false + - value: Tonga + type: String + displayName: Tonga + required: false + - value: Trinidad and Tobago + type: String + displayName: Trinidad and Tobago + required: false + - value: Tunisia + type: String + displayName: Tunisia + required: false + - value: Turkey + type: String + displayName: Turkey + required: false + - value: Turkmenistan + type: String + displayName: Turkmenistan + required: false + - value: Turks and Caicos Islands + type: String + displayName: Turks and Caicos Islands + required: false + - value: Tuvalu + type: String + displayName: Tuvalu + required: false + - value: Uganda + type: String + displayName: Uganda + required: false + - value: Ukraine + type: String + displayName: Ukraine + required: false + - value: United Arab Emirates + type: String + displayName: United Arab Emirates + required: false + - value: United Kingdom + type: String + displayName: United Kingdom + required: false + - value: US Minor Outlying Islands + type: String + displayName: US Minor Outlying Islands + required: false + - value: Uruguay + type: String + displayName: Uruguay + required: false + - value: Uzbekistan + type: String + displayName: Uzbekistan + required: false + - value: Vanuatu + type: String + displayName: Vanuatu + required: false + - value: Vatican City State + type: String + displayName: Vatican City State + required: false + - value: Venezuela + type: String + displayName: Venezuela + required: false + - value: Vietnam + type: String + displayName: Vietnam + required: false + - value: 'Virgin Islands, British' + type: String + displayName: 'Virgin Islands, British' + required: false + - value: 'Virgin Islands, U.S' + type: String + displayName: 'Virgin Islands, U.S' + required: false + - value: Wallis and Futuna + type: String + displayName: Wallis and Futuna + required: false + - value: Western Sahara + type: String + displayName: Western Sahara + required: false + - value: Yemen + type: String + displayName: Yemen + required: false + - value: Zambia + type: String + displayName: Zambia + required: false + - value: Zimbabwe + type: String + displayName: Zimbabwe + required: false + required: false + validation: + warnings: + - field: Addresses.Country + details: Required if TaxNumber is supplied + information: [] + required: false + validation: + warnings: + - field: Addresses + details: 'If supplied, must contain only 1 address' + - field: Addresses + details: 'If TaxNumber is supplied, an Address with a Country is required' + information: [] + required: true + Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: true + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: true + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: true + country: + type: String + displayName: Country + description: The country for the address + required: true + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: true + required: true + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: true + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + required: true + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Suppliers + description: 'An accounts payable contact that supplies good or services, also referred to as a vendor.' + properties: + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + phone: + type: String + displayName: Phone + description: Main contact phone number for the supplier. + required: false + validation: + warnings: + - field: phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email + description: Main contact email for the supplier. + required: false + registrationNumber: + type: String + displayName: Registration Number + description: Legal company registration identifier. + required: false + validation: + warnings: + - field: registrationNumber + details: Max length of 50 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal tax registration identifier. + required: false + status: + type: String + displayName: Status + description: Status of the supplier account. + options: + - value: Active + type: String + displayName: Active + required: false + - value: InActive + type: String + displayName: Inactive + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Address Line 1 + description: First line of the address. + required: false + validation: + warnings: + - field: addresses.line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Address Line 2 + description: Second line of the address. + required: false + validation: + warnings: + - field: addresses.line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: Local city for the address. + required: false + validation: + warnings: + - field: addresses.city + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: Region the address is located in. + required: false + validation: + warnings: + - field: addresses.region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: Country for the address. + required: false + validation: + warnings: + - field: addresses.country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + validation: + warnings: + - field: addresses.postalCode + details: Only English alphabet characters are permitted. + - field: addresses.postalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: + - field: addresses.type + details: 'Billing = POBOX, Delivery/Unknown = DELIVERY' + information: [] + required: false + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-suppliers-model + x-speakeasy-group: loan-writeback.suppliers + description: "The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behavior**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" + '/companies/{companyId}/connections/{connectionId}/push/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Sage Intacct: + value: + id: '73593' + supplierName: test 20230420 1004 + contactName: Joe Bloggs + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create supplier + description: "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behavior**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model).\r\n" + operationId: create-supplier + x-speakeasy-group: loan-writeback.suppliers + '/companies/{companyId}/connections/{connectionId}/options/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create transfer model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be provided and be greater than zero. + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: false + validation: + warnings: + - field: To.Amount + details: 'If provided, must be greater than zero.' + - field: To.Amount + details: It will be taken into account just if the accounts are in different currencies and will override the automatic currency conversion. + information: [] + required: true + required: true + Oracle NetSuite: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: false + validation: + warnings: [] + information: + - field: Date + details: Will default to today's date if not provided + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.Id + details: 'One location, one department and one classification may be provided' + information: [] + required: false + required: true + validation: + warnings: + - details: Currently only transfers between bank accounts and undeposited funds accounts are supported + information: [] + QuickBooks Desktop: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Value should match To.Amount + - field: From.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: From.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Value should match To.Amount + - field: To.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: To.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + required: false + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Max length of 4096 characters. + information: [] + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + required: false + validation: + warnings: + - field: ContactRef + details: 'This value is not used in the push, and will be ignored.' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + QuickBooks Online: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + Sage Business Cloud Accounting: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Must be provided if pushing a bank deposit. + information: + - field: Description + details: Must not be longer than 2000 characters. + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from To.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from From.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + required: true + required: true + Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: From.Status + details: Must be provided. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: To.Status + details: Must be provided. + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-transfers-model + x-speakeasy-group: loan-writeback.transfers + description: | + The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + summary: Create transfer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + QuickBooks Desktop: + value: + description: test transfers push 20230126 12.08 + contactRef: + id: 80000028-167239230944 + dataType: customers + date: '2023-01-26T11:51:18.104Z' + from: + accountRef: + id: 80000028-1671794219 + dataType: bankAccounts + amount: 12 + to: + accountRef: + id: 80000004-1671793811 + dataType: bankAccounts + amount: 12 + status: Unknown + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + metadata: + isDeleted: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateTransferResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). + operationId: create-transfer + x-speakeasy-group: loan-writeback.transfers + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Loan writeback + summary: Get create bank account transactions model + description: |- + The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + operationId: get-create-bank-transactions-model + x-speakeasy-group: loan-writeback.bank-transactions + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + post: + tags: + - Loan writeback + summary: Create bank account transactions + description: | + The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/lending-api#/operations/get-create-bankTransactions-model). + operationId: create-bank-transactions + x-speakeasy-group: loan-writeback.bank-transactions + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactions' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactionsResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/options/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create direct cost model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: [] + information: + - field: Note + details: is not supported and will be ignored + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: is not supported and will be ignored + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If unspecified, base currency is assumed. Must agree with the bank account in PaymentAllocations' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Required if the currency is not the base currency + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + validation: + warnings: [] + information: + - field: SubTotal + details: is not supported and will be ignored + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + validation: + warnings: [] + information: + - field: TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: is not supported and will be ignored + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: is not supported and will be ignored + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: is not supported and will be ignored + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountAmount + details: is not supported and will be ignored + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountPercentage + details: is not supported and will be ignored + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Required if totalAmount is not specified + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Required if subTotal is not specified + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.Name + details: is not supported and will be ignored + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.EffectiveTaxRate + details: is not supported and will be ignored + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: false + validation: + warnings: [] + information: + - field: LineItems.ItemRef + details: is not supported and will be ignored + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: is not supported and will be ignored + required: true + validation: + warnings: + - field: LineItems + details: Only one line is supported + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + validation: + warnings: [] + information: + - field: Payment.CurrencyRate + details: is not supported and will be ignored + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + validation: + warnings: [] + information: + - field: Payment.PaidOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: is not supported and will be ignored + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.CurrencyRate + details: is not supported and will be ignored + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.AllocatedOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: is not supported and will be ignored + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Only one line is supported + information: [] + required: true + FreeAgent: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + id: + type: String + displayName: Unique Direct Transaction ID + description: 'The identifier for the direct transaction, unique to the company' + required: false + validation: + warnings: + - field: Id + details: 'will be ignored on push. ' + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: 'is not supported by FreeAgent and will not be mapped. ' + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: must be provided + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + validation: + warnings: + - field: ContactRef.Id + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: false + validation: + warnings: + - field: ContactRef.DataType + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: must be provided + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: + - field: CurrencyRate + details: 'will be ignored on push. ' + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: 'If a Note is provided, this field will be ignored on push. ' + information: [] + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: + - field: LineItems.UnitAmount + details: 'will be ignored on push. ' + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Quantity + details: 'will be ignored on push. ' + information: [] + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: 'will be ignored on push. ' + information: [] + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: + - field: TaxRateRef.Name + details: 'will be ignored on push. ' + information: [] + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: + - field: TaxRateRef.EffectiveTaxRate + details: 'will be ignored on push. ' + information: [] + required: false + required: true + validation: + warnings: + - field: LineItems + details: Exactly one line item must be specified + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: false + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: false + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + required: false + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + validation: + warnings: + - field: ModifiedDate + details: 'will be ignored on push. ' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + validation: + warnings: + - field: SourceModifiedDate + details: 'will be ignored on push. ' + information: [] + required: true + Oracle NetSuite: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Should have the same sign across all line items + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Should not be a bank account + - field: LineItems.AccountRef + details: Should only be specified when pushing an expense + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Should only be specified when pushing an item (not an expense) + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Should be specified when item type is not 'Discount' + information: [] + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + required: false + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Credit Card' + information: [] + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Represents the check number + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: + - field: Note + details: Max length of 4096 characters. + information: [] + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: The account in which to make the deposit + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + validation: + warnings: [] + information: + - field: Payment.Reference + details: Use to reference the check number of this deposit. + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must contain a single payment allocation + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + Sage 50 (UK): + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: The user reference for this direct cost. + required: false + issueDate: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + currency: + type: String + displayName: Currency + description: The currency in which the direct cost is issued in. + required: true + validation: + warnings: + - field: currency + details: This must match the target account's default currency. + information: [] + currencyRate: + type: Number + displayName: Currency Rate + description: The currency rate associated with this transaction. + required: true + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this direct cost from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + subTotal: + type: Number + displayName: Sub Total + description: The net amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line net amounts + taxAmount: + type: Number + displayName: Tax Amount + description: The tax amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line tax amounts + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + lineItems: + type: Array + displayName: Line Items + description: Line items of the direct cost. + properties: + description: + type: String + displayName: description + description: Description of the direct cost line item. + required: false + accountRef: + type: Object + displayName: Nominal Code + description: Target bank account for the direct cost line item. + properties: + id: + type: String + displayName: Id + description: The ID of the Account the line is linked to. + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: Unit amount for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.unitAmount + details: Cannot equal 0 and will be set to Net amount if not provided accordingly. + information: [] + quantity: + type: Number + displayName: Quantity + description: Quantity for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.quantity + details: Must be 1 or -1. + information: [] + subTotal: + type: Number + displayName: Net Amount + description: 'Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.' + required: true + validation: + warnings: + - field: LineItems.subTotal + details: Cannot have both subtotal and tax amount as 0 for line item. + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: Tax amount for the direct cost line item. + required: false + validation: + warnings: + - field: LineItems.taxAmount + details: Cannot have both tax amount and subtotal as 0 for line item. + information: [] + totalAmount: + type: Number + displayName: Total Amount + description: Total amount for the direct cost line item. + required: false + validation: + warnings: [] + information: + - field: LineItems.totalAmount + details: Will be auto populated using tax amount and net amount. + taxCode: + type: Number + displayName: Tax Code Id + description: The tax code ID associated with this transaction. + required: true + trackingCategoryRefs: + type: Object + displayName: Tracking Category References + description: Tracking categories associated with this transaction. + properties: + id: + type: String + displayName: Id + description: The ID of the tracking category associated with the transaction + required: true + validation: + warnings: + - field: id + details: 'A department is required. If a project reference is provided, the cost code for that project must also be provided.' + information: [] + required: true + required: true + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Intacct: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: Must be used to provide payee's name and contain no more than 80 characters. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: Must be an existing tax rate in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not contain no more than 1000 characters. + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: false + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must contain at least one line item. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail. + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not contain no more than 45 characters. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: true + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: true + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: true + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + name: + type: String + displayName: Name + description: The name of the item referenced by the identifier + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + tracking: + type: Object + displayName: Tracking + description: Information this item is being tracked against + properties: + recordRefs: + type: Array + displayName: Record References + description: A collection of records this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + invoiceTo: + type: Object + displayName: Invoice To + description: The entity the record should be invoiced to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + required: true + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: Must be provided. + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not exceed 255 characters. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + validation: + warnings: [] + information: + - field: TaxAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + validation: + warnings: [] + information: + - field: TotalAmount + details: Must be provided. + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must be a valid GUID. + - field: ContactRef.Id + details: Must match the ID of an existing contact. + information: + - field: ContactRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: ContactRef + details: Must be provided. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a bank account. + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Payment + details: Must be provided. + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + validation: + warnings: + - field: Allocation.TotalAmount + details: Must be equal to the sum of line items. + information: + - field: Allocation.TotalAmount + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Allocation + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must be provided. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not be longer than 4000 characters long. + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: Must be provided. + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: + - field: LineItems.TotalAmount + details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: + - field: LineItems.TotalAmount + details: 'When one line is negative, all lines must be negative.' + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: LineItems.AccountRef + details: Must be provided. + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: [] + information: + - field: TrackingCategoryRefs.Id + details: Must be provided. + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: Tracking categories must not have the same parent tracking category. + - field: LineItems.TrackingCategoryRefs + details: Maximum of 2 Tracking Categories. + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: Must match the ID of an existing tax rate. + information: + - field: TaxRateRef.Id + details: 'If not provided, will be set to the default tax rate for the line''s account.' + required: false + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: false + validation: + warnings: + - field: ItemRef.Id + details: Must be a valid GUID. + - field: ItemRef.Id + details: Must match the ID of an existing item. + information: [] + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must be provided. + required: true + validation: + warnings: + - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: [] + Zoho Books: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Should be provided when SubTotal is not provided + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Should be provided when TotalAmount is not provided + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Is required when pushing a negative direct cost + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: Is required when pushing a negative direct cost + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: Is required when pushing a negative direct cost + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-directCosts-model + x-speakeasy-group: loan-writeback.direct-costs + description: | + The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create direct cost + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + examples: + QuickBooks Desktop: + value: + reference: test ref + note: directCost 21/03 09.20 + contactRef: + id: 80000001-1671793885 + dataType: suppliers + issueDate: '2023-03-21T10:19:52.223Z' + currency: USD + lineItems: + - description: test description line 1 + unitAmount: 7 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 99 + taxAmount: 360 + totalAmount: 70 + accountRef: + id: 8000000D-1671793811 + name: Purchases - Hardware for Resale + itemRef: + id: 80000001-1674566705 + name: item test + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + paymentAllocations: + - payment: + note: payment allocations note + reference: payment allocations reference + accountRef: + id: 80000028-1671794219 + name: Bank Account 1 + paidOnDate: '2023-01-28T10:19:52.223Z' + totalAmount: 54 + allocation: + currencyRate: 0 + allocatedOnDate: '2023-01-29T10:19:52.223Z' + totalAmount: 88 + subTotal: 362 + taxAmount: 4 + totalAmount: 366 + Xero: + value: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25' + currency: GBP + lineItems: + - description: negative direct cost + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + taxRateRef: + id: INPUT2 + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + allocation: + totalAmount: -42 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + FreeAgent: + value: + issueDate: '2023-02-12' + currency: GBP + lineItems: + - unitAmount: 15 + quantity: 1 + subTotal: 15 + accountRef: + id: '288' + paymentAllocations: + - payment: + accountRef: + id: 750-1 + allocation: {} + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + Sage Intacct: + value: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateDirectCostResponse' + examples: + FreeAgent: + value: + changes: [] + data: + id: '372060709' + issueDate: '2023-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '288' + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '372060709' + accountRef: + id: 750-1 + currency: GBP + paidOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + allocation: + currency: GBP + allocatedOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + sourceModifiedDate: '2023-02-12T15:15:53Z' + dataType: directCosts + companyId: a23f79d6-7cc9-486c-b388-8ab88faea947 + pushOperationKey: 0659a24d-2b66-4979-971e-4b98c3ed7f61 + dataConnectionKey: 35e38cd5-66ea-41b8-b555-9efd5b792b68 + requestedOnUtc: '2023-02-12T15:15:51.1723204Z' + completedOnUtc: '2023-02-12T15:15:54.7161036Z' + status: Success + statusCode: 200 + Sage Intacct: + value: + changes: + - type: Created + recordRef: + dataType: directCosts + data: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + taxRateRef: + id: '95' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + dataType: directCosts + companyId: d7f743a9-1804-4116-8c8a-e606f7e2f66c + pushOperationKey: 0d74c1ad-00ad-4731-9e6e-98a86056959a + dataConnectionKey: fa139396-523a-4a58-bf2b-8da82c8a673f + requestedOnUtc: '2023-03-31T12:49:51.6503324Z' + status: Pending + statusCode: 202 + Xero: + value: + changes: [] + data: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25T00:00:00' + currency: GBP + lineItems: + - description: negative direct cost + taxRateRef: + id: INPUT2 + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + paidOnDate: '0001-01-01T00:00:00' + totalAmount: 0 + allocation: + totalAmount: -42 + subTotal: 0 + taxAmount: -7 + totalAmount: -42 + dataType: directCosts + companyId: b5efee61-3fab-4a5d-9247-de03d6eda6db + pushOperationKey: 33347930-fcc5-4f95-aa13-4a0f7291b559 + dataConnectionKey: 1e355304-4476-422e-95cb-fa2a6d47fab4 + requestedOnUtc: '2023-02-24T13:43:26.5109173Z' + status: Pending + validation: + errors: [] + warnings: [] + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). + operationId: create-direct-cost + x-speakeasy-group: loan-writeback.direct-costs + '/companies/{companyId}/connections/{connectionId}/options/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create payment model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + FreeAgent: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: [] + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must match the sum of the line amounts. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must match the sum of the link amounts. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Other + type: String + displayName: Other + required: false + required: true + required: true + required: true + validation: + warnings: + - field: Lines + details: Only one line may be specified + information: [] + required: true + FreshBooks: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: Payment Amount must not exceed Invoice Amount Due or available Customer Credit + - field: Lines.Links + details: Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount + information: [] + required: true + validation: + warnings: + - field: Lines + details: Only one line is supported + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + options: + - value: AED + type: Array + displayName: AED + required: false + - value: AFN + type: Array + displayName: AFN + required: false + - value: ALL + type: Array + displayName: ALL + required: false + - value: AMD + type: Array + displayName: AMD + required: false + - value: ANG + type: Array + displayName: ANG + required: false + - value: AOA + type: Array + displayName: AOA + required: false + - value: ARS + type: Array + displayName: ARS + required: false + - value: AUD + type: Array + displayName: AUD + required: false + - value: AWG + type: Array + displayName: AWG + required: false + - value: AZN + type: Array + displayName: AZN + required: false + - value: BAM + type: Array + displayName: BAM + required: false + - value: BBD + type: Array + displayName: BBD + required: false + - value: BDT + type: Array + displayName: BDT + required: false + - value: BGN + type: Array + displayName: BGN + required: false + - value: BHD + type: Array + displayName: BHD + required: false + - value: BIF + type: Array + displayName: BIF + required: false + - value: BMD + type: Array + displayName: BMD + required: false + - value: BND + type: Array + displayName: BND + required: false + - value: BOB + type: Array + displayName: BOB + required: false + - value: BRL + type: Array + displayName: BRL + required: false + - value: BSD + type: Array + displayName: BSD + required: false + - value: BTN + type: Array + displayName: BTN + required: false + - value: BWP + type: Array + displayName: BWP + required: false + - value: BYR + type: Array + displayName: BYR + required: false + - value: BZD + type: Array + displayName: BZD + required: false + - value: CAD + type: Array + displayName: CAD + required: false + - value: CDF + type: Array + displayName: CDF + required: false + - value: CHF + type: Array + displayName: CHF + required: false + - value: CLP + type: Array + displayName: CLP + required: false + - value: CNY + type: Array + displayName: CNY + required: false + - value: COP + type: Array + displayName: COP + required: false + - value: CRC + type: Array + displayName: CRC + required: false + - value: CUC + type: Array + displayName: CUC + required: false + - value: CUP + type: Array + displayName: CUP + required: false + - value: CVE + type: Array + displayName: CVE + required: false + - value: CZK + type: Array + displayName: CZK + required: false + - value: DJF + type: Array + displayName: DJF + required: false + - value: DKK + type: Array + displayName: DKK + required: false + - value: DOP + type: Array + displayName: DOP + required: false + - value: DZD + type: Array + displayName: DZD + required: false + - value: EGP + type: Array + displayName: EGP + required: false + - value: ERN + type: Array + displayName: ERN + required: false + - value: ETB + type: Array + displayName: ETB + required: false + - value: EUR + type: Array + displayName: EUR + required: false + - value: FJD + type: Array + displayName: FJD + required: false + - value: FKP + type: Array + displayName: FKP + required: false + - value: GBP + type: Array + displayName: GBP + required: false + - value: GEL + type: Array + displayName: GEL + required: false + - value: GGP + type: Array + displayName: GGP + required: false + - value: GHS + type: Array + displayName: GHS + required: false + - value: GIP + type: Array + displayName: GIP + required: false + - value: GMD + type: Array + displayName: GMD + required: false + - value: GNF + type: Array + displayName: GNF + required: false + - value: GTQ + type: Array + displayName: GTQ + required: false + - value: GYD + type: Array + displayName: GYD + required: false + - value: HKD + type: Array + displayName: HKD + required: false + - value: HNL + type: Array + displayName: HNL + required: false + - value: HRK + type: Array + displayName: HRK + required: false + - value: HTG + type: Array + displayName: HTG + required: false + - value: HUF + type: Array + displayName: HUF + required: false + - value: IDR + type: Array + displayName: IDR + required: false + - value: ILS + type: Array + displayName: ILS + required: false + - value: IMP + type: Array + displayName: IMP + required: false + - value: INR + type: Array + displayName: INR + required: false + - value: IQD + type: Array + displayName: IQD + required: false + - value: IRR + type: Array + displayName: IRR + required: false + - value: ISK + type: Array + displayName: ISK + required: false + - value: JEP + type: Array + displayName: JEP + required: false + - value: JMD + type: Array + displayName: JMD + required: false + - value: JOD + type: Array + displayName: JOD + required: false + - value: JPY + type: Array + displayName: JPY + required: false + - value: KES + type: Array + displayName: KES + required: false + - value: KGS + type: Array + displayName: KGS + required: false + - value: KHR + type: Array + displayName: KHR + required: false + - value: KMF + type: Array + displayName: KMF + required: false + - value: KPW + type: Array + displayName: KPW + required: false + - value: KRW + type: Array + displayName: KRW + required: false + - value: KWD + type: Array + displayName: KWD + required: false + - value: KYD + type: Array + displayName: KYD + required: false + - value: KZT + type: Array + displayName: KZT + required: false + - value: LAK + type: Array + displayName: LAK + required: false + - value: LBP + type: Array + displayName: LBP + required: false + - value: LKR + type: Array + displayName: LKR + required: false + - value: LRD + type: Array + displayName: LRD + required: false + - value: LSL + type: Array + displayName: LSL + required: false + - value: LYD + type: Array + displayName: LYD + required: false + - value: MAD + type: Array + displayName: MAD + required: false + - value: MDL + type: Array + displayName: MDL + required: false + - value: MGA + type: Array + displayName: MGA + required: false + - value: MKD + type: Array + displayName: MKD + required: false + - value: MMK + type: Array + displayName: MMK + required: false + - value: MNT + type: Array + displayName: MNT + required: false + - value: MOP + type: Array + displayName: MOP + required: false + - value: MRO + type: Array + displayName: MRO + required: false + - value: MUR + type: Array + displayName: MUR + required: false + - value: MVR + type: Array + displayName: MVR + required: false + - value: MWK + type: Array + displayName: MWK + required: false + - value: MXN + type: Array + displayName: MXN + required: false + - value: MYR + type: Array + displayName: MYR + required: false + - value: MZN + type: Array + displayName: MZN + required: false + - value: NAD + type: Array + displayName: NAD + required: false + - value: NGN + type: Array + displayName: NGN + required: false + - value: NIO + type: Array + displayName: NIO + required: false + - value: NOK + type: Array + displayName: NOK + required: false + - value: NPR + type: Array + displayName: NPR + required: false + - value: NZD + type: Array + displayName: NZD + required: false + - value: OMR + type: Array + displayName: OMR + required: false + - value: PAB + type: Array + displayName: PAB + required: false + - value: PEN + type: Array + displayName: PEN + required: false + - value: PGK + type: Array + displayName: PGK + required: false + - value: PHP + type: Array + displayName: PHP + required: false + - value: PKR + type: Array + displayName: PKR + required: false + - value: PLN + type: Array + displayName: PLN + required: false + - value: PYG + type: Array + displayName: PYG + required: false + - value: QAR + type: Array + displayName: QAR + required: false + - value: RON + type: Array + displayName: RON + required: false + - value: RSD + type: Array + displayName: RSD + required: false + - value: RUB + type: Array + displayName: RUB + required: false + - value: RWF + type: Array + displayName: RWF + required: false + - value: SAR + type: Array + displayName: SAR + required: false + - value: SBD + type: Array + displayName: SBD + required: false + - value: SCR + type: Array + displayName: SCR + required: false + - value: SDG + type: Array + displayName: SDG + required: false + - value: SEK + type: Array + displayName: SEK + required: false + - value: SGD + type: Array + displayName: SGD + required: false + - value: SHP + type: Array + displayName: SHP + required: false + - value: SLL + type: Array + displayName: SLL + required: false + - value: SOS + type: Array + displayName: SOS + required: false + - value: SPL + type: Array + displayName: SPL + required: false + - value: SRD + type: Array + displayName: SRD + required: false + - value: STD + type: Array + displayName: STD + required: false + - value: SVC + type: Array + displayName: SVC + required: false + - value: SYP + type: Array + displayName: SYP + required: false + - value: SZL + type: Array + displayName: SZL + required: false + - value: THB + type: Array + displayName: THB + required: false + - value: TJS + type: Array + displayName: TJS + required: false + - value: TMT + type: Array + displayName: TMT + required: false + - value: TND + type: Array + displayName: TND + required: false + - value: TOP + type: Array + displayName: TOP + required: false + - value: TRY + type: Array + displayName: TRY + required: false + - value: TTD + type: Array + displayName: TTD + required: false + - value: TVD + type: Array + displayName: TVD + required: false + - value: TWD + type: Array + displayName: TWD + required: false + - value: TZS + type: Array + displayName: TZS + required: false + - value: UAH + type: Array + displayName: UAH + required: false + - value: UGX + type: Array + displayName: UGX + required: false + - value: USD + type: Array + displayName: USD + required: false + - value: UYU + type: Array + displayName: UYU + required: false + - value: UZS + type: Array + displayName: UZS + required: false + - value: VEF + type: Array + displayName: VEF + required: false + - value: VND + type: Array + displayName: VND + required: false + - value: VUV + type: Array + displayName: VUV + required: false + - value: WST + type: Array + displayName: WST + required: false + - value: XAF + type: Array + displayName: XAF + required: false + - value: XCD + type: Array + displayName: XCD + required: false + - value: XDR + type: Array + displayName: XDR + required: false + - value: XOF + type: Array + displayName: XOF + required: false + - value: XPF + type: Array + displayName: XPF + required: false + - value: YER + type: Array + displayName: YER + required: false + - value: ZAR + type: Array + displayName: ZAR + required: false + - value: ZMW + type: Array + displayName: ZMW + required: false + - value: ZWD + type: Array + displayName: ZWD + required: false + required: false + validation: + warnings: + - field: Currency + details: Can be used for Payments on Account only + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing customer. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Precision must be maximum of two decimal places. + - field: TotalAmount + details: Must be greater than zero. + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not be greater than 8 characters long. + currency: + type: String + displayName: Currency + description: Currency of the payment + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Precision must be maximum of two decimal places. + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense') + information: [] + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be greater than zero + - field: TotalAmount + details: Must be provided and must be equal to the sum of the lines amounts + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: The id format should be 'location-' + information: + - field: Reference + details: This field can be used to provide a tracking category id (Location only) + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted' + information: [] + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing supplier. + information: [] + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing 'Bank' or 'Other Current Asset' account. + information: + - field: AccountRef.Id + details: Not required if total amount of the payment is 0. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: Max length of 20 characters. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code that matches the currency of the customer. + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must match the sum of amounts in the lines + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: + - field: Lines.Amount + details: Amount plus the sum of amounts in the links must equal 0 + information: [] + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + validation: + warnings: + - field: Links.Type + details: 'Only 1 link with type ''PaymentOnAccount'' may be specified per line, this line may contain no other links' + - field: Links.Type + details: Only 1 link with type 'Invoice' may be specified per line + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this invoice from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + customerRef: + type: Object + displayName: Customer + description: Customer to be paid. + properties: + id: + type: String + displayName: Customer Id + description: Identifier of the customer. + required: true + validation: + warnings: + - field: customerRef.id + details: Must match the ID of an existing customer and have a max length of 8 characters. + information: [] + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid to the customer. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + reference: + type: Number + displayName: Reference + description: The user reference for this invoice payment. + required: false + date: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + note: + type: Number + displayName: Note + description: A description of the payment. + required: false + lines: + type: Array + displayName: Line Items + description: Line items of the payment. + properties: + amount: + type: Number + displayName: Amount + description: The amount of this line item + required: true + validation: + warnings: [] + information: + - details: this must equal the negative of the sum of the link amounts + links: + type: Array + displayName: Links + description: Links to the invoice being paid. + properties: + amount: + type: Number + displayName: Amount + description: The amount to be added to the value of the invoice + required: true + validation: + warnings: [] + information: + - details: 'When paying off an invoice, this value will be negative' + id: + type: String + displayName: Invoice Id + description: The ID of the invoice to pay + required: true + type: + type: String + displayName: Payment Link Type + description: The type of the item to be paid + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + required: true + required: true + validation: + warnings: [] + information: + - details: Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response. + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing Account. + information: + - field: AccountRef.Id + details: Must be provided. + required: false + validation: + warnings: + - field: AccountRef + details: Required unless the Payment is only allocating a Credit Note. + information: [] + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing Customer. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be zero when allocating against Invoices using a Credit Note only. + - field: TotalAmount + details: Must equal the sum of the link items amount. + information: + - field: TotalAmount + details: Must be provided. + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + validation: + warnings: + - field: Note + details: Should not be longer than 25 characters. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If supplied, must match the currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: Must be greater than zero except when Type is Invoice + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: PaymentOnAccount + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: [] + information: + - field: TotalAmount + details: Must equal the sum of Lines.Amount. + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + validation: + warnings: [] + information: + - field: Note + details: Must be less than 1000 characters. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + options: + - value: '1' + type: String + displayName: Printed Check + required: false + - value: '3' + type: String + displayName: Credit Card + required: false + - value: '5' + type: String + displayName: EFT + required: false + - value: '6' + type: String + displayName: Cash + required: false + required: true + required: true + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: [] + information: + - field: Reference + details: Can be used to set the Document/Check No. in Sage Intacct. + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Is required if currency is provided. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must occur after the date the invoice was created. + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: [] + information: + - field: CustomerRef.Id + details: Must be an existing customer ID in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: For undeposited payments use the GL account record number to charge. + - field: AccountRef.Id + details: 'To charge either a savings, checking or credit card account use its associated GL account number.' + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: When added together with the sum of the Links.Amount the total must be zero. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: 'Must be a valid Record No. from accounts receivable of either an invoice for an ''Invoice'', adjustment for a ''CreditNote'' or an advance for a ''PaymentOnAccount'' in Sage Intacct.' + - field: Links.Id + details: Must be an integer. + - field: Links.Id + details: Must related to CustomerRef.Id in Sage Intacct. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be one of Invoiceor CreditNoteor PaymentOnAccount. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must not be more than the total amount due for an invoice or the available funds in the account to be charged. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount. + - field: Lines.Links + details: Must contain only one Invoice. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must contain at least one payment line. + required: true + validation: + warnings: [] + information: + - details: Sage Intacct handles allocated payments only. + Sandbox: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + companyName: + type: String + displayName: Name + description: The name of the customer referenced by the identifier + required: true + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + name: + type: String + displayName: Name + description: The name of the payment method referenced by the identifier + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the currency of the linked transaction + required: true + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + required: true + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing account. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be either a type of BANK account or enable payments must be switched on. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: 'Must be greater than 0, unless the payment is a credit note allocation.' + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: Must be a valid GUID. + information: + - field: Links.Id + details: Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice. + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. + required: true + Zoho Books: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: AccountRef.ID is required when making a payment to an invoice and/or a payment on account + information: [] + required: true + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + validation: + warnings: + - field: Currency + details: must match the currency of any invoices or credit notes + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: must be greater than or equal to 0 + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: the sum of all link amounts must equal the negated total amount of the payment + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - type: Array + displayName: Invoice + required: false + - type: Array + displayName: CreditNote + required: false + - type: Array + displayName: PaymentOnAccount + required: false + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: 'if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed' + information: [] + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-payment-model + x-speakeasy-group: loan-writeback.payments + description: |- + The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create payment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + QuickBooks Desktop: + value: + customerRef: + id: 80000002-1674552702 + companyName: string + accountRef: + id: '8000002E-1675267199' + name: Undeposited Funds + paymentMethodRef: + id: string + name: string + totalAmount: 28 + currency: USD + currencyRate: 1 + date: '2023-02-10T11:47:04.792Z' + note: note 14/02 1147 + lines: + - amount: 28 + links: + - type: Invoice + id: 181-1676374586 + amount: -28 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref 14/02 1147 + Sage 50 (UK): + value: + customerRef: + id: CUST1 + accountRef: + id: '1200' + name: Bank Current Account + paymentMethodRef: + id: '4405' + totalAmount: 4 + currency: GBP + currencyRate: 1 + date: '2023-03-17T11:47:04.792Z' + note: note 07/03 14.31 + lines: + - amount: 4 + links: + - type: Invoice + id: INV-31 + amount: -4 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref + Sage Business Cloud Accounting: + value: + customerRef: + id: 30444c5bd4964fd787c7f8e2e5301ce1 + companyName: Stanley test customer + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 0.17 + currency: GBP + currencyRate: 1 + date: '2023-03-20T11:47:04.792Z' + note: Need to send products asap. + lines: + - amount: 0.17 + links: + - type: Invoice + id: bb85db9226d7450fb99eb83e7fb37505 + amount: -0.17 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: normal payment 20/03 17.05 + Sage Intacct: + value: + customerRef: + id: '19' + accountRef: + id: '81' + date: '2022-03-12T00:00:00' + totalAmount: 0 + lines: + - amount: 0 + links: + - id: '246' + type: Invoice + amount: -1.1 + - id: '280' + type: CreditNote + amount: 1.1 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreatePaymentResponse' + examples: + Sage Intacct: + value: + data: + customerRef: + id: '19' + accountRef: + id: '81' + totalAmount: 0 + date: '2022-03-12T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '246' + amount: -1.1 + - type: CreditNote + id: '280' + amount: 1.1 + dataType: payments + companyId: ffa6368e-fde4-4165-9a0a-4bda1a6f916e + pushOperationKey: 673f5d97-1c53-41ef-b9c8-cc9a8415d17c + dataConnectionKey: bbecdbf3-913a-43ae-9c91-e830b3686657 + requestedOnUtc: '0001-01-01T00:00:00' + status: Pending + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). + operationId: create-payment + x-speakeasy-group: loan-writeback.payments + '/companies/{companyId}/push/{pushOperationKey}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/pushOperationKey' + get: + summary: Get create operation + tags: + - Loan writeback + operationId: get-create-operation + x-speakeasy-group: loan-writeback.create-operations + description: Retrieve create operation. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/push': + parameters: + - $ref: '#/components/parameters/companyId' + get: + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + summary: List create operations + tags: + - Loan writeback + operationId: list-create-operations + x-speakeasy-group: loan-writeback.create-operations + description: List create operations. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperations' + examples: {} + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/configuration': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + summary: Get upload configuration + description: "Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection.\n\nWith this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.\n\nWhen you use the [*Upload data*](https://docs.codat.io/lending-api#/operations/upload-bank-statement-data) endpoint next, you must upload the data for the account you configured. " + operationId: get-bank-statement-upload-configuration + x-speakeasy-name-override: get-upload-configuration + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + tags: + - Bank statements + summary: Set upload configuration + description: "Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection. \n\nWith this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.\n\nEach data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. " + operationId: set-bank-statement-upload-configuration + x-speakeasy-name-override: set-upload-configuration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/startSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Bank statements + summary: Start upload session + description: "Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company.\n\nA session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. \n\nYou can only have one active session per data type at a time. You can complete or cancel a session using the [*End upload session*](https://docs.codat.io/lending-api#/operations/end-bank-statement-upload-session) endpoint." + operationId: start-bank-statement-upload-session + x-speakeasy-name-override: start-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartUploadSessionRequest' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/upload': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + - $ref: '#/components/parameters/path' + post: + tags: + - Bank statements + summary: Upload data + description: "During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session.\n\nMake sure you created configuration for the account using the [*Set upload configuration*](https://docs.codat.io/lending-api#/operations/set-bank-statement-upload-configuration) endpoint before attempting an upload. " + operationId: upload-bank-statement-data + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/BankingTransactions' + - $ref: '#/components/schemas/ThirdPartySchema' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/endSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + post: + tags: + - Bank statements + summary: End upload session + description: |- + Use the *End upload session* endpoint to finalize a bank statement upload session. Include a `status` in the request body to indicate if you want to cancel the processing of the dataset or trigger the ingestion and enrichment of the data. + + A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + operationId: end-bank-statement-upload-session + x-speakeasy-name-override: end-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EndUploadSessionRequest' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/{reportType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + post: + tags: + - Manage reports + summary: Generate report + description: |- + Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter. + + This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. + operationId: generate-report + x-speakeasy-name-override: generate-report + responses: + '202': + description: Accepted (pending) + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/{reportType}/{reportId}/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Manage reports + summary: Get report status + description: |+ + Use the *Get report status* endpoint to return the metadata about report generation, such as its current status, date of request, and date of generation. + + You can either provide the ID of a report or use `latest` as the ID value to get the most recent generated *reportName* report for the company. + + operationId: get-report-status + x-speakeasy-name-override: get-report-status + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: Get categorized bank statement transactions + description: |- + The *Get categorized bank statement transactions* endpoint returns fully categorized bank transactions for a company. Transaction data is obtained from the company's connected bank accounts. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: get-categorized-bank-statement-transactions + x-speakeasy-name-override: get-categorized-bank-statement-transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementTransactions' + example: + pageNumber: 1 + pageSize: 100 + totalResults: 2194 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + results: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: List categorized bank statement accounts + description: "The *Get categorized bank statement accounts* endpoint returns a list of bank accounts associated with categorized transactions for a company. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`." + operationId: list-categorized-bank-statement-accounts + x-speakeasy-name-override: list-categorized-bank-statement-accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementAccounts' + example: + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=10 + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Bank statements + summary: Download categorized bank statement Excel + description: "Use the *Download categorized bank statement Excel* endpoint to download the categorized bank statement Excel file. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`." + operationId: download-categorized-bank-statement-excel + x-speakeasy-name-override: download-categorized-bank-statement-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Financial summary + summary: Download credit model Excel + description: "> **Available as beta release**\n>\n> This endpoint is part of a beta release. Please contact your account manager if you want to enable it.\n\nUse the *Download Credit Model Excel* endpoint to download the credit model Excel file. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`." + operationId: download-credit-model-excel + x-speakeasy-name-override: download-credit-model-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Manage reports + summary: List reports + description: 'Use the *List reports* endpoint to return details (such as generation''s current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results.' + operationId: list-reports + x-speakeasy-name-override: list-reports + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation/definitions/reports' + example: + pageNumber: 1 + pageSize: 4 + totalResults: 15 + _links: + self: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports + current: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=1&pageSize=4 + next: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=2&pageSize=4 + results: + - id: c0d52c82-777f-4309-81a0-d935aea0562b + status: InProgress + type: categorizedBankStatement + requested: '2024-10-15T07:00:00Z' + updated: '2024-10-15T15:31:45Z' + - id: 79ef0451-edbd-4108-82ff-0b991444f1ec + status: Complete + type: categorizedBankStatement + requested: '2024-09-10T05:50:00Z' + updated: '2024-09-11T14:37:12Z' + - id: ae125b45-ed37-4bb4-bb4a-d55383fd56b2 + status: Complete + type: categorizedBankStatement + requested: '2024-09-06T07:47:10Z' + updated: '2024-09-20T14:42:15Z' + - id: ebfaf90c-31fe-407f-a016-bc2b3e60894a + status: Error + type: categorizedBankStatement + requested: '2024-07-15T04:45:14Z' + updated: '2024-07-15T17:41:45Z' + errorMessage: Failed to generate the report because.... + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/financialSummary': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + get: + tags: + - Financial summary + summary: Get financial summary insights + description: |- + > **Available as beta release** + > + > This endpoint is part of a beta release. Please contact your account manager if you want to enable it. + + Financial summary insights provide high-level indicators about the accuracy and completeness of a business’s financial data. These insights include: + - Closed Books Indicator – An estimate of the most recent accounting period officially closed by a business + - Accounting Score – An evaluation of the quality and completeness of a business’s bookkeeping + + Before accessing this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`. + + > Please note that missing elements might be disabled for the account. Please contact account manager for more details. + operationId: get-financial-summary + x-speakeasy-name-override: get-financial-summary + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FinancialSummary' + example: + booksClosedDate: + date: '2025-05-31T00:00:00Z' + reason: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + score: 90 + reason: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + '204': + description: No content + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' +webhooks: + Account categories updated: + post: + requestBody: + description: Triggered when a company's accounts are categorized. + content: + application/json: + schema: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reached: + post: + description: Called when your client’s request count to Codat's API surpasses the allocated quota. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reached: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reached + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 0 + expiryDate: '2024-09-01T12:14:14Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reset: + post: + description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reset: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reset + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 11993 + expiryDate: '2024-09-01T23:59:99Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.successful: + post: + description: Called when a categorized bank statement is successfully generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.unsuccessful: + post: + description: Called when a categorized bank statement has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.successful: + post: + description: Called when a credit model report is successfully generated. + requestBody: + content: + application/json: + schema: + title: Report generation webhook + type: object + properties: + id: + type: string + format: uuid + example: ba29118f-5406-4e59-b05c-ba307ca38d01 + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - reports.categorizedBankStatement.generate.successful + - reports.creditModel.generate.successful + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema/definitions/ReportGenerationPayload' + definitions: + ReportGenerationPayload: + title: Report generation payload + type: object + properties: + id: + type: string + format: uuid + example: a78e2625-7190-4d94-ae3b-071320451026 + description: Unique identifier of the report. + referenceCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.unsuccessful: + post: + description: Called when a credit model report has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + AccountCategoriesUpdatedWebhook: + title: Account categories updated webhook + description: Webhook request body for the "Account categories updated" event. + x-internal: true + type: object + properties: + ClientId: + title: Client ID + type: string + format: uuid + description: Unique identifier for your client in Codat. + ClientName: + type: string + description: Name of your client in Codat. + CompanyId: + $ref: '#/components/parameters/companyId/schema' + DataConnectionId: + $ref: '#/components/parameters/connectionId/schema' + RuleId: + type: string + format: uuid + description: Unique identifier for the rule. + deprecated: true + RuleType: + type: string + x-stoplight: + id: 34d52a089f08a + description: The type of rule. + AlertId: + type: string + format: uuid + description: Unique identifier of the webhook event. + Message: + type: string + description: A human-readable message about the webhook. + Data: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook/definitions/AccountCategoriesUpdatedWebhookData' + definitions: + AccountCategoriesUpdatedWebhookData: + type: object + title: Account categories updated webhook data + properties: + modifiedDate: + $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' + description: The date on which the company's account categories were last modified in Codat. + examples: + - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + ClientName: Bank of Dave + CompanyId: 8a210b68-6988-11ed-a1eb-0242ac120002 + DataConnectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac + RuleType: Account Categories Updated + AlertId: a9367074-b5c3-42c4-9be4-be129f43577e + Message: Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968. + Data: + modifiedDate: '2019-08-24T14:15:22Z' + AccountingAccount: + title: 'Accounting: Account' + description: "\uFEFF\x3E\x20\x2A\x2A\x4C\x61\x6E\x67\x75\x61\x67\x65\x20\x74\x69\x70\x3A\x2A\x2A\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x61\x6C\x73\x6F\x20\x72\x65\x66\x65\x72\x72\x65\x64\x20\x74\x6F\x20\x61\x73\x20\x2A\x2A\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x2A\x2A\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x61\x6E\x64\x20\x2A\x2A\x67\x65\x6E\x65\x72\x61\x6C\x20\x6C\x65\x64\x67\x65\x72\x2A\x2A\x2E\n\n\x23\x23\x20\x4F\x76\x65\x72\x76\x69\x65\x77\n\n\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x75\x73\x65\x73\x20\x74\x6F\x20\x72\x65\x63\x6F\x72\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2E\x20\x46\x72\x6F\x6D\x20\x74\x68\x65\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x72\x65\x74\x72\x69\x65\x76\x65\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x63\x6C\x75\x64\x65\x3A\n\x2A\x20\x41\x73\x73\x65\x74\n\x2A\x20\x45\x78\x70\x65\x6E\x73\x65\n\x2A\x20\x49\x6E\x63\x6F\x6D\x65\n\x2A\x20\x4C\x69\x61\x62\x69\x6C\x69\x74\x79\n\x2A\x20\x45\x71\x75\x69\x74\x79\x2E\n\n\x54\x68\x65\x20\x73\x61\x6D\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x61\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x62\x61\x73\x65\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x69\x74\x20\x69\x73\x20\x75\x73\x65\x64\x20\x69\x6E\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x63\x75\x72\x72\x65\x6E\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x6B\x6E\x6F\x77\x6E\x20\x61\x73\x20\x63\x68\x65\x63\x6B\x69\x6E\x67\x20\x69\x6E\x20\x74\x68\x65\x20\x55\x53\x29\x20\x73\x68\x6F\x75\x6C\x64\x20\x62\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x61\x73\x20\x60\x41\x73\x73\x65\x74\x2E\x43\x75\x72\x72\x65\x6E\x74\x60\x20\x66\x6F\x72\x20\x58\x65\x72\x6F\x2C\x20\x61\x6E\x64\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x2E\x43\x68\x65\x63\x6B\x69\x6E\x67\x60\x20\x66\x6F\x72\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x2E\n\n\x41\x74\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x74\x69\x6D\x65\x2C\x20\x65\x61\x63\x68\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x69\x74\x73\x20\x6F\x77\x6E\x20\x72\x65\x71\x75\x69\x72\x65\x6D\x65\x6E\x74\x73\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x50\x61\x79\x70\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x58\x65\x72\x6F\x20\x69\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x60\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x61\x6E\x64\x20\x74\x68\x65\x72\x65\x66\x6F\x72\x65\x20\x72\x65\x71\x75\x69\x72\x65\x73\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x74\x6F\x20\x62\x65\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2E\n\n\x54\x6F\x20\x64\x65\x74\x65\x72\x6D\x69\x6E\x65\x20\x74\x68\x65\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x3A\n\x2D\x20\x46\x6F\x6C\x6C\x6F\x77\x20\x6F\x75\x72\x20\x5B\x43\x72\x65\x61\x74\x65\x2C\x20\x75\x70\x64\x61\x74\x65\x2C\x20\x64\x65\x6C\x65\x74\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x70\x75\x73\x68\x29\x20\x67\x75\x69\x64\x65\x20\x61\x6E\x64\x20\x75\x73\x65\x20\x74\x68\x65\x20\x5B\x47\x65\x74\x20\x63\x72\x65\x61\x74\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x6F\x64\x65\x6C\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x63\x72\x65\x61\x74\x65\x2D\x63\x68\x61\x72\x74\x4F\x66\x41\x63\x63\x6F\x75\x6E\x74\x73\x2D\x6D\x6F\x64\x65\x6C\x29\x2E\n\x2D\x20\x52\x65\x66\x65\x72\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x27\x73\x20\x6F\x77\x6E\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x2E\n\n\x3E\x20\x2A\x2A\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\n\x3E\n\x3E\x20\x49\x66\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x73\x20\x70\x75\x6C\x6C\x65\x64\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x69\x74\x73\x20\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x63\x6F\x64\x65\x20\x64\x6F\x65\x73\x20\x6E\x6F\x74\x20\x6C\x69\x65\x20\x77\x69\x74\x68\x69\x6E\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x6C\x61\x79\x6F\x75\x74\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x74\x68\x65\x6E\x20\x74\x68\x65\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x69\x73\x20\x60\x55\x6E\x6B\x6E\x6F\x77\x6E\x60\x2E\x20\x54\x68\x65\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x43\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\x20\x61\x6E\x64\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x4E\x61\x6D\x65\x2A\x2A\x20\x66\x69\x65\x6C\x64\x73\x20\x72\x65\x74\x75\x72\x6E\x20\x60\x6E\x75\x6C\x6C\x60\x2E\n\x3E\n\x3E\x20\x54\x68\x69\x73\x20\x61\x70\x70\x72\x6F\x61\x63\x68\x20\x67\x69\x76\x65\x73\x20\x61\x20\x74\x72\x75\x65\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x68\x69\x6C\x73\x74\x20\x70\x72\x65\x76\x65\x6E\x74\x69\x6E\x67\x20\x64\x69\x73\x74\x6F\x72\x74\x69\x6E\x67\x20\x66\x69\x6E\x61\x6E\x63\x69\x61\x6C\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x70\x72\x6F\x66\x69\x74\x20\x61\x6E\x64\x20\x6C\x6F\x73\x73\x20\x61\x6E\x64\x20\x62\x61\x6C\x61\x6E\x63\x65\x20\x73\x68\x65\x65\x74\x20\x72\x65\x70\x6F\x72\x74\x73\x2E" + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + - $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountPrototype: + title: Account prototype + type: object + properties: + nominalCode: + type: string + nullable: true + description: 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. + example: '610' + name: + type: string + nullable: true + description: Name of the account. + example: Accounts Receivable + description: + type: string + nullable: true + description: Description for the account. + example: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: + type: string + nullable: true + description: "Full category of the account. \r\n\r\nFor 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." + example: Asset.Current + fullyQualifiedName: + type: string + nullable: true + description: |- + Full name of the account, for example: + - `Cash On Hand` + - `Rents Held In Trust` + - `Fixed Asset` + examples: + - Cash On Hand + - Fixed Asset + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currentBalance: + type: number + format: decimal + nullable: true + description: Current balance in the account. + example: 0 + type: + $ref: '#/components/schemas/AccountingAccount/definitions/accountType' + status: + $ref: '#/components/schemas/AccountingAccount/definitions/accountStatus' + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validDatatypeLinks: + type: array + nullable: true + description: '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](/lending-api#/schemas/ValidDataTypeLinks).' + items: + title: Valid data type links + description: "When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.\n\nFor example, `validDatatypeLinks` might indicate the following references:\n\n- Which tax rates are valid to use on the line item of a bill.\n- Which items can be used when creating an invoice. \n\nYou can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.\n\n## `validDatatypeLinks` example\n\nThe following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.\n\n```json validDatatypeLinks for an account\n{\n \"id\": \"bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4\",\n \"nominalCode\": \"090\",\n \"name\": \"Business Bank Account\",\n #...\n \"validDatatypeLinks\": [\n {\n \"property\": \"Id\",\n \"links\": [\n \"Payment.AccountRef.Id\",\n \"BillPayment.AccountRef.Id\",\n \"DirectIncome.LineItems.AccountRef.Id\",\n \"DirectCost.LineItems.AccountRef.Id\"\n ]\n }\n ]\n }\n```\n\n\n\n## Support for `validDatatypeLinks`\n\nCodat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. \n\nIf you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap." + type: object + properties: + property: + type: string + nullable: true + description: The property from the account that can be linked. + links: + type: array + nullable: true + description: Supported `dataTypes` that the record can be linked to. + items: + type: string + supplementalData: + $ref: '#/components/schemas/SupplementalData' + accountRef: + title: Account reference + type: object + description: 'Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.' + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + name: + type: string + description: '''name'' from the Accounts data type.' + accountType: + title: Account type + enum: + - Unknown + - Asset + - Expense + - Income + - Liability + - Equity + type: string + description: Type of account + example: Asset + accountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the account + example: Active + type: object + AccountingAccounts: + title: 'Accounting: Accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingAccountTransaction: + title: 'Accounting: Account transaction' + description: |- + > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions). + + ## Overview + + In Codat’s data model, account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Account transactions are created as a result of different business activities, for example: + + * Payments: for example, receiving money for payment against an invoice. + * Bill payments: for example, spending money for a payment against a bill. + * Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment. + * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale. + * Transfers: for example, transferring money between two bank accounts. + + Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier of the direct cost (unique to the company). + transactionId: + type: string + nullable: true + description: Identifier of the transaction (unique to the company). + note: + type: string + nullable: true + description: 'Additional information about the account transaction, if available.' + bankAccountRef: + $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountRef' + description: Reference to the bank account the account transaction is recorded against. + date: + $ref: '#/components/schemas/DateTime' + description: The date the account transaction was recorded in the platform. + status: + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + type: string + description: The status of the account transaction. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lines: + type: array + nullable: true + description: Array of account transaction lines. + items: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLine' + totalAmount: + type: number + format: decimal + description: 'Total amount of the account transactions, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountTransactionLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the account transaction. + recordRef: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLineRecordRef' + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + accountTransactionLineRecordRef: + type: object + title: Record reference + description: Links an account transaction line to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingAccountTransactions: + title: 'Accounting: Account transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccountTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingAddress: + title: 'Accounting: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/AccountingAddress/definitions/accountingAddressType' + line1: + type: string + nullable: true + description: Line 1 of the customer address. + line2: + type: string + nullable: true + description: Line 2 of the customer address. + city: + type: string + nullable: true + description: City of the customer address. + region: + type: string + nullable: true + description: Region of the customer address. + country: + type: string + nullable: true + description: Country of the customer address. + postalCode: + type: string + nullable: true + description: Postal code or zip code. + required: + - type + definitions: + accountingAddressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + AccountingAgedCreditorReport: + title: 'Accounting: Aged creditors report' + description: "The Aged Creditors report shows the total balance owed by a business to its suppliers over time.\n\nYou can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.\n\nTotal assets or liabilities are grouped into 30-day periods for each supplier, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.\n\n> It is not guaranteed that write-offs are included in the Aged Creditors report.\n\n## Underlying data\n\nThe Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment).\n\nTo generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.\n\n> The Aged Creditor report runs based on the **issue dates** of the underlying data types rather than the due date.\n\n## Accessing the Aged Creditors report in Portal\n\nApart from returning the report via the API as JSON and query, you can also return the Aged Creditors report in the Codat portal.\n\n1. In the navigation bar, click **Companies**.\n2. Click the name of the company you want to generate the report for. The company's data page is displayed.\n3. Click the **Accounting** tab then click **Reports**.\n4. Select **Aged Creditors**.\n5. _(Optional)_ Edit the default reporting parameters.\n a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. \n b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).\n b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).\n6. To run the report, click **Load aged creditors**.\n7. The report is generated and displayed at the bottom of the page.\n\nThe report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes." + type: object + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged creditor. + items: + $ref: '#/components/schemas/AccountingAgedCreditorReport/definitions/agedCreditor' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Bills + amount: 1547.5 + definitions: + agedCreditor: + title: Aged creditor + type: object + properties: + supplierId: + type: string + description: Supplier ID of the aged creditor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + supplierName: + type: string + description: Supplier name of the aged creditor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged creditors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + AccountingAgedDebtorReport: + type: object + title: 'Accounting: Aged debtors report' + description: "The Aged Debtors report shows the total outstanding balance due from customers to the business over time. \n\nYou can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.\n\nTotal assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.\n\n> It is not guaranteed that write-offs are included in the Aged Debtors report.\n\n## Underlying data\n\nThe Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment).\n\nTo generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.\n\n> The Aged Debtors report runs based on the **issue dates** of the underlying data types rather than the due date.\n\n## Accessing the Aged Debtors report in Portal\n\nApart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal.\n\n1. In the navigation bar, click **Companies**.\n2. Click the name of the company you want to generate the report for. The company's data page is displayed.\n3. Click the **Accounting** tab then click **Reports**.\n4. Select **Aged Debtors**.\n5. _(Optional)_ Edit the default reporting parameters.\n a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. \n b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).\n b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).\n6. To run the report, click **Load aged debtors**.\n7. The report is generated and displayed at the bottom of the page.\n\nThe report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes." + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged debtors. + items: + $ref: '#/components/schemas/AccountingAgedDebtorReport/definitions/agedDebtor' + definitions: + agedDebtor: + title: Aged debtor + type: object + properties: + customerId: + type: string + description: Customer ID of the aged debtor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: + type: string + description: Customer name of the aged debtor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged debtors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Invoices + amount: 1547.5 + AccountingAttachment: + title: 'Accounting: Attachment' + description: "The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.\n\n> **Retrieving attachments**\n> \n> If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.\n\nUnlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments.\n\nNote that different integrations have different requirements to file size and extension of attachments.\n\n| Integration | File size | File extension |\n|-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Xero | 4 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 |\n| QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |\n| NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |\n| 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\". |\n" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the attachment, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the attachment file. + contentType: + type: string + nullable: true + description: "File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**.\n\nSupported file types vary per platform. " + dateCreated: + $ref: '#/components/schemas/DateTime' + fileSize: + type: integer + format: int32 + nullable: true + description: 'File size in bytes. For example, if this reads **46153**, then the file size is 46kb.' + includeWhenSent: + type: boolean + description: 'If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting software allows this.' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: [] + definitions: + attachments: + title: Attachments + type: object + properties: + attachments: + description: An array of attachments related to the record. + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + AccountingBalanceSheet: + title: 'Accounting: Balance sheet' + description: |- + ## Overview + + The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes. + + > **Balance sheet or profit and loss report?** + > + > A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time. + + **Structure of this report** + This report will reflect the structure and line descriptions that the business has set in their own accounting software. + + **History** + By default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings). + + **Want to pull this in a standardised structure?** + Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. + type: object + additionalProperties: false + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the balance sheet. + reports: + type: array + description: An array of balance sheet reports. + items: + $ref: '#/components/schemas/AccountingBalanceSheet/definitions/balanceSheet' + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Earliest available monthly report data. + required: + - reports + definitions: + balanceSheet: + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Point in time when a snapshot of a company's financial position is taken. + assets: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for assets. For example, fixed and current assets.' + liabilities: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for liabilities. For example, current liabilities.' + netAssets: + type: number + format: decimal + description: Value of net assets for a company in their base currency. + equity: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for equities. For example, retained and current year earnings. See below.' + required: + - netAssets + AccountingBankAccount: + title: 'Accounting: Bank account' + description: "> **Accessing Bank Accounts through Banking API**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n> \n> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/lending-api#/schemas/Account) data type.\n\n## Overview\n\nA list of bank accounts associated with a company and a specific data connection.\n\nBank accounts data includes:\n* The name and ID of the account in the accounting software.\n* The currency and balance of the account.\n* The sort code and account number." + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company in the accounting software.' + - $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + bankAccountPrototype: + title: Bank account prototype + type: object + properties: + accountName: + type: string + nullable: true + description: Name of the bank account in the accounting software. + accountType: + $ref: '#/components/schemas/AccountingBankAccountType' + nominalCode: + type: string + nullable: true + description: Code used to identify each nominal account for a business. + sortCode: + type: string + nullable: true + description: |- + 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. + accountNumber: + type: string + nullable: true + description: |- + 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. + iBan: + type: string + nullable: true + description: International bank account number of the account. Often used when making or receiving international payments. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Base currency of the bank account. + balance: + type: number + format: decimal + nullable: true + description: Balance of the bank account. + institution: + type: string + nullable: true + description: The institution of the bank account. + availableBalance: + type: number + format: decimal + nullable: true + description: 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. + overdraftLimit: + type: number + format: decimal + nullable: true + description: |- + 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`. + status: + $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountStatus' + bankAccountCreateResponse: + title: Create bank account response + allOf: + - properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + bankAccountRef: + title: Bank account reference + type: object + properties: + id: + type: string + description: Bank account 'id' for the account transaction. + name: + type: string + description: bank account 'name' for the account transaction. + description: Links to the Account transactions data type. + bankAccounts: + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + bankAccountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the bank account. + example: Active + AccountingBankAccounts: + x-internal: true + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingBankAccountType: + title: Bank Account Type + x-internal: true + enum: + - Unknown + - Credit + - Debit + type: string + description: "The type of transactions and balances on the account. \nFor Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. \nFor Debit accounts, positive balances are assets, and positive transactions **increase** assets." + AccountingBankTransaction: + title: 'Accounting: Bank account transaction' + description: "> **Accessing Bank Accounts through Banking API**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n>\n> To view bank account data through the Banking API, please refer to the new [Banking: Transaction](https://docs.codat.io/lending-api#/operations/list-transactions) data type.\n\n## Overview\n\nTransactional banking data for a specific company and account.\n\nBank transactions include the:\n* Amount of the transaction.\n* Current account balance.\n* Transaction type, for example, credit, debit, or transfer." + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bank transaction, unique to the company in the accounting software.' + accountId: + type: string + nullable: true + description: Unique identifier to the `accountId` the bank transactions originates from. + clearedOnDate: + $ref: '#/components/schemas/DateTime' + description: + type: string + nullable: true + description: Description of the bank transaction. + reconciled: + type: boolean + description: '`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + transactionType: + $ref: '#/components/schemas/AccountingBankTransaction/definitions/bankTransactionType' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + bankTransactionType: + title: Bank transaction type + description: Type of transaction for the bank statement line. + type: string + enum: + - Unknown + - Credit + - Debit + - Int + - Div + - Fee + - SerChg + - Dep + - Atm + - Pos + - Xfer + - Check + - Payment + - Cash + - DirectDep + - DirectDebit + - RepeatPmt + - Other + AccountingBankTransactions: + title: 'Accounting: Accounting bank transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingBill: + title: 'Accounting: Bill' + description: |- + > **Invoices or bills?** + > + > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill. + > + > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills. + + ## Overview + + In Codat, a bill contains details of: + * When the bill was recorded in the accounting system. + * How much the bill is for and the currency of the amount. + * Who the bill was received from — the *supplier*. + * What the bill is for — the *line items*. + + Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*. + + You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: + type: string + nullable: true + description: User-friendly reference for the bill. + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + purchaseOrderRefs: + type: array + nullable: true + items: + title: Purchase order Reference + type: object + additionalProperties: false + properties: + id: + type: string + description: 'Identifier for the purchase order, unique for the company in the accounting software.' + purchaseOrderNumber: + type: string + nullable: true + description: 'Friendly reference for the purchase order, commonly generated by the accounting software.' + issueDate: + allOf: + - description: Date of the bill as recorded in the accounting software. + - $ref: '#/components/schemas/DateTime' + dueDate: + allOf: + - description: Date the supplier is due to be paid. + - $ref: '#/components/schemas/DateTime' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: Array of Bill line items. + items: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem' + withholdingTax: + type: array + nullable: true + items: + type: object + properties: + name: + minLength: 1 + type: string + description: Name assigned to withheld tax. + amount: + type: number + format: decimal + description: Amount of tax withheld. + required: + - amount + - name + status: + $ref: '#/components/schemas/AccountingBill/definitions/billStatus' + subTotal: + type: number + format: decimal + description: 'Total amount of the bill, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: Amount of tax on the bill. + totalAmount: + type: number + format: decimal + description: 'Amount of the bill, including tax.' + amountDue: + type: number + format: decimal + nullable: true + description: Amount outstanding on the bill. + note: + type: string + nullable: true + description: 'Any private, company notes about the bill, such as payment information.' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - status + - subTotal + - taxAmount + - totalAmount + definitions: + billStatus: + description: Current state of the bill. + type: string + enum: + - Unknown + - Open + - PartiallyPaid + - Paid + - Void + - Draft + billLineItem: + title: Bill line item + type: object + properties: + lineNumber: + type: string + nullable: true + description: The bill line's number. + description: + type: string + nullable: true + description: Friendly name of the goods or services received. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: |- + Numerical value of any discounts applied. + + Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the bill. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + nullable: true + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the line item is linked.' + purchaseOrderLineRef: + allOf: + - type: object + x-internal: true + title: Record line reference + description: "Links the current record line to the underlying record line that created it. \n\nFor example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. " + properties: + id: + type: string + description: '''id'' of the underlying record.' + dataType: + type: string + description: Allowed name of the 'dataType'. + enum: + - purchaseOrders + - bills + lineNumber: + type: string + description: Line number of the underlying record. + - description: Reference to the purchase order line this line was generated from. + trackingCategoryRefs: + type: array + nullable: true + description: Collection of categories against which this item is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + isDirectCost: + type: boolean + description: The bill is a direct cost if `True`. + AccountingBillCreditNote: + title: 'Accounting: Bill credit note' + description: "> **Bill credit notes or credit notes?**\n> \n> In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).\n\n## Overview\n\nA bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills.\n\nIn the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier). \n\nA bill credit note includes details of:\n* The original and remaining credit.\n* Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill).\n* The supplier that issued the bill credit note." + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier for the bill credit note that is unique to a company in the accounting software. + example: 1509398f-98e2-436d-8a5d-c042e0c74ffc + billCreditNoteNumber: + type: string + nullable: true + description: Friendly reference for the bill credit note. + example: 91fe2a83-e161-4c21-929d-c5c10c4b07e5 + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: 'Total amount of credit that has been applied to the business'' account with the supplier, including discounts and tax.' + example: 805.78 + totalDiscount: + type: number + format: decimal + description: Total value of any discounts applied. + example: 0 + subTotal: + type: number + format: decimal + description: 'Total amount of the bill credit note, including discounts but excluding tax.' + example: 805.78 + totalTaxAmount: + type: number + format: decimal + description: Amount of tax included in the bill credit note. + example: 0 + discountPercentage: + type: number + format: decimal + description: Percentage rate of any discount applied to the bill credit note. + example: 0 + remainingCredit: + type: number + format: decimal + description: Amount of the bill credit note that is still outstanding. + example: 0 + status: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteStatus' + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date the bill credit note was issued by the supplier. + example: '2022-03-15T00:00:00' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Date the bill credit note was fully refunded or allocated. + example: '2022-09-15T16:35:00' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the bill credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: 'An array of line ' + items: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem' + paymentAllocations: + nullable: true + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + createdFromRefs: + nullable: true + type: array + description: An array of records the credit note was created from. + items: + $ref: '#/components/schemas/AccountingRecordRef' + note: + type: string + nullable: true + description: Any additional information about the bill credit note. + example: 'Bill Credit Note with 1 line items, totaling 805.78' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - status + definitions: + billCreditNoteStatus: + type: string + description: Current state of the bill credit note + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + example: Paid + billCreditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been received.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + title: Tax rate reference + type: object + description: |- + Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. + + Found on: + + - Bill line items + - Bill Credit Note line items + - Credit Note line items + - Direct incomes line items + - Invoice line items + - Items + properties: + id: + type: string + description: Unique identifier for the tax rate in the accounting software. + name: + type: string + description: Name of the tax rate in the accounting software. + effectiveTaxRate: + type: number + format: decimal + description: Applicable tax rate. + itemRef: + description: Reference to the item the line is linked to. + title: Item reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for the item in the accounting software. + name: + type: string + nullable: true + description: Name of the item in the accounting software. + required: + - id + createdFromLineRef: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem/properties/purchaseOrderLineRef/allOf/0' + description: Reference to the line of the item that the current line was created from. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + required: + - unitAmount + - quantity + examples: + - id: 6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d + billCreditNoteNumber: '14763237' + totalAmount: 693 + remainingCredit: 693 + status: Submitted + issueDate: '2019-02-18T16:03:07.268Z' + note: Track separately + currency: USD + lineItems: + - description: AcmeMagnet + unitAmount: 25 + discountAmount: 0 + quantity: 4 + subTotal: 100 + taxAmount: 10 + totalAmount: 110 + itemRef: + id: '3' + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + trackingCategoryRefs: + - id: department_1 + name: ACMERockets + - id: costcode_2 + name: ACM2-ACMESigns + createdFromLineRef: + - id: '8462' + dataType: bill + lineNumber: 1 + - description: ACMEDisintegratingPistol + unitAmount: 25 + discountAmount: 0 + quantity: 3 + subTotal: 75 + taxAmount: 7.5 + totalAmount: 82.5 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEWhippedCreamDispenser + unitAmount: 52 + discountAmount: 0 + quantity: 6 + subTotal: 312 + taxAmount: 31.2 + totalAmount: 343.2 + itemRef: + id: 3691f3d9-0ff7-4358-8a93-bed31c1b4b03 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEJetPropelledPogoStick + unitAmount: 130 + discountAmount: 0 + quantity: 1 + subTotal: 130 + taxAmount: 27.3 + totalAmount: 157.3 + itemRef: + id: 075410d4-7edc-4936-ba52-9e1e43cbe300 + taxRateRef: + id: d606732b-db18-44d7-823b-7f15f42c32ea + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + supplierRef: + id: 67C6A7A1-5E84-4AC4-B950-24A114E379D0 + supplierName: Chin's Gas and Oil + createdFromLineRef: + id: '8462' + dataType: bills + line: 1 + AccountingBillCreditNotes: + title: 'Accounting: Bill credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingBillPayment: + title: 'Accounting: Bill payment' + description: "> **Bill payments or payments?** \n> \n> We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.\n>\n> See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).\n\n## Overview\n\nBill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)).\n\nA bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:\n\n- A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment.\n- An allocation of a supplier's credit note to a bill or perhaps a refund.\n- A bill payment made directly to an accounts payable account. This could be an overpayment or a prepayment, or a refund of a payment made directly to an accounts payable account.\n\nDepending on the bill payments which are allowed by the underlying accounting software, some of these types may be combined. Please see the example data section for samples of what these cases look like.\n\nIn Codat, a bill payment contains details of:\n\n- When the bill payment was recorded in the accounting system.\n- How much it is for and in the currency.\n- Who the payment has been paid to, the _supplier_.\n- The types of bill payments, the _line items_. \n\nSome accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.\n\nBill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n\n---\n\n## Bill payment types\n\n### Payment of a bill\n\nA payment paying a single bill should have the following properties:\n\n- A `totalAmount` indicating the amount of the bill that was paid. This is always positive.\n- A `lines` array containing one element with the following properties:\n - An `amount` equal to the `totalAmount` above.\n - A `links` array containing one element with the following properties:\n - A `type` indicating the type of link, in this case a `Bill`.\n - An `id` containing the ID of the bill that was paid.\n - An amount of `-totalAmount` (negative `totalAmount`), indicating that the entirety of the paid amount is allocated to the bill.\n\n### Payment of multiple bills\n\nIt is possible for one payment to pay multiple bills. This can be represented using two possible formats, depending on how the supplier keeps their books:\n\n1. The payment has multiple entries in its **lines** array, one for each bill that is paid. Each line will follow the above example for paying a bill, and the rules detailed in the data model.\n2. The payment has a line with multiple links to each bill. This occurs when the proportion of the original payment allocated to each bill is not available.\n\nEach line is the same as those described above, with the **amount** indicating how much of the payment is allocated to the bill. The **amount** on the lines sum to the **totalAmount** on the payment.\n\n> Pushing batch payments to Xero\n> \n> When pushing a single bill payment to Xero to pay multiple bills, only the first format is supported—multiple entries in the payment **lines** array.\n\n### Payments and refunds on account\n\nA payment on account, that is a payment that doesn’t pay a specific bill, has one entry in its lines array.\n\nThe line has the following properties:\n\n- A **totalAmount** indicating the amount paid by a supplier or refunded to them by a company. A payment to the supplier is always negative. A refund is always positive.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.\n - The **id** containing the ID of the supplier.\n - An amount for the link is `0` **totalAmount** or the amount of the payment or refund.\n\nIt is possible to have a payment that is part on account and part allocated to a bill. Each line should follow the examples above.\n\n### Using a credit note to pay a bill\n\nThe payment of a bill using a credit note has one entry in its `lines` array. This **line** has the following properties:\n\n- An **amount** indicating the amount of money moved, which in this case is `0`, as the credit note and bill allocation must balance each other.\n- A **links** array containing two elements:\n - The first link has:\n - A **type** indicating the type of link, in this case a `Bill`.\n - An **id** containing the ID of the bill that was paid.\n - The second link has:\n - A **type** indicating the type of link, in this case a `CreditNote`.\n - An **id** containing the ID of the credit note used by this payment.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n### Refunding a credit note\n\nA bill payment refunding a credit note has one entry in its **lines** array. This line has the following properties:\n\n- An **amount** indicating the amount of the credit note that was refunded. This is always negative, indicating that it is a refund.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of `link`, in this case a `CreditNote`.\n - An **id** containing the ID of the credit note that was refunded.\n\nThe **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable.\n\n### Refunding a payment\n\nIf a payment is refunded, for example, when a company overpaid a bill and the overpayment is returned, there are two payment records: \n\n- One for the incoming overpayment.\n- Another for the outgoing refund.\n\nThe payment issuing the refund is identified by the fact that the **totalAmount** is negative. This payment has one entry in its lines array that have the following properties:\n\n- An **amount** indicating the amount that was refunded. This is always negative.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of a the link, in this case a `BillPayment`.\n - An **id** containing the ID of the payment that was refunded.\n\nThe **amount** field on the line equals the **totalAmount** on the payment and is negative as this is money leaving accounts payable.\n\nThe payment that was refunded can be identified as it has a line where the `amount` on its `line` is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was partly used to pay an bill. For example, a £1,050 payment paying a £1,000 bill with a refund of £50 has two lines: \n\n- One for £1,000 linked to the bill that was paid\n- Another for £50 linked to the payment that refunded the over payment. This link is of type `Refund` but the ID corresponds to a bill payment.\n\nThe line linked to the bill payment has the following properties:\n\n- An **amount** indicating the amount that was refunded. This is positive as its money that was added to accounts payable, but is balanced out by the negative amount of the refund.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of the link, in this case a `Refund`.\n - An **id** containing the ID of the payment that refunded this line.\n\n> Linked payments\n> \n> Not all accounting software support linked payments in this way. In these platforms you may see a payment on account and a refund on account.\n\n## Foreign currencies\n\nThere are two types of currency rate that are detailed in the bill payments data type: \n\nPayment currency rate: \n\n- Base currency of the accounts payable account.\n- Foreign currency of the bill payment.\n\nPayment line link currency rate: \n\n- Base currency of the item that the link represents.\n- Foreign currency of the payment.\n\nThese two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a bill payment is applied to an item in a currency that does not match either:\n\n- The base currency for the accounts payable account. \n- The currency of the item.\n" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + example: 3d5a8e00-d108-4045-8823-7f342676cffa + supplierRef: + allOf: + - $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + - description: Supplier against which the payment is recorded in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is linked to in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. + example: 1329.54 + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: ISO currency code in which the bill payment is recorded in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: Date the bill payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Additional information associated with the payment. + example: Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 + paymentMethodRef: + allOf: + - $ref: '#/components/schemas/PaymentMethodRef' + - description: The Payment Method to which the payment is linked in the accounting software. + lines: + type: array + nullable: true + description: An array of bill payment lines. + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLine' + reference: + type: string + nullable: true + description: Additional information associated with the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + billPaymentLine: + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: AllocatedOnDate must be specified and be later than the issue date of the bill. + required: + - amount + billPaymentLineLink: + type: object + properties: + type: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLinkType' + id: + type: string + nullable: true + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: |- + Amount by which the balance of the linked entity is altered, in the currency of the linked entity. + + - A negative link amount reduces the outstanding amount on the accounts payable account. + - A positive link amount increases the outstanding amount on the accounts payable account. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + billPaymentLineLinkType: + description: Types of links to bill payment lines. + type: string + enum: + - Unknown + - Unlinked + - Bill + - Other + - CreditNote + - BillPayment + - PaymentOnAccount + - Refund + - ManualJournal + - Discount + examples: + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: 2000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: 1000 + - totalAmount: 250 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -750 + - type: CreditNote + id: 'y' + amount: 750 + - amount: 250 + links: + - type: Bill + id: x + amount: -250 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - totalAmount: 2000 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: z + amount: 1000 + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: customer-001 + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: w + amount: -1000 + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - type: CreditNote + id: z + amount: 1000 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 4000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -4000 + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: Bill + id: 'y' + amount: -1000 + - amount: 3000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -3000 + - totalAmount: 500 + lines: + - amount: 500 + links: + - type: Bill + id: a + amount: -1000 + - type: Bill + id: b + amount: -1000 + - type: CreditNote + id: 'y' + amount: 750 + - type: CreditNote + id: z + amount: 750 + AccountingBillPayments: + title: 'Accounting: Bill payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingBills: + title: 'Accounting: Bills' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBill' + - $ref: '#/components/schemas/PagingInfo' + AccountingCashFlowStatement: + title: 'Accounting: Cash flow statement' + description: "> **Operating activities only** \n> \n> Currently, the cash flow statement shows cash that flows into and out of the company from operating activities *only*. Operating activities generate cash from the sale of goods or services.\n\n## Overview\n\nA cash flow statement is a financial report that records all cash that is received or spent by a company during a given period. It gives you a clearer picture of the company’s performance, and their ability to pay creditors and finance growth.\n\n> **Cash flow statement or balance sheet?**\n> \n> Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees." + type: object + properties: + reports: + description: Array of cash flow statements. + type: array + items: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/cashFlowStatement' + reportBasis: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportBasis' + reportInput: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportInput' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of all values in the cash flow statement. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + required: + - reports + - reportBasis + - reportInput + definitions: + reportBasis: + title: Report basis + description: 'Accounting method used when aggregating the report data. In this case, `Cash`.' + type: string + enum: + - Unknown + - Accrual + - Cash + reportInput: + description: Accounting method used to prepare the cash flow statement. + type: string + enum: + - Unknown + - Indirect + - Direct + cashFlowStatement: + title: Cash flow statement + type: object + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date for the reporting period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date for the reporting period. + cashReceipts: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash receipts from the sale of goods. + cashPayments: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash payments to suppliers for the purchase of goods or services. + AccountingCompanyInfo: + title: 'Accounting: Company information' + description: "Company info provides standard details about a linked company such as their address, phone number, and company registration.\n\n> **Company information or companies?**\n> \n> 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." + type: object + properties: + companyName: + type: string + nullable: true + description: Name of the linked company. + accountingPlatformRef: + type: string + nullable: true + description: Identifier or reference for the company in the accounting software. + companyLegalName: + type: string + nullable: true + description: Registered legal name of the linked company. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + phoneNumbers: + type: array + nullable: true + description: An array of phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + type: array + nullable: true + description: An array of weblinks. + items: + $ref: '#/components/schemas/WebLink' + ledgerLockDate: + $ref: '#/components/schemas/DateTime' + description: 'If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end.' + registrationNumber: + type: string + nullable: true + description: Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + taxNumber: + type: string + nullable: true + description: Company tax number. + financialYearStartDate: + $ref: '#/components/schemas/DateTime' + description: Start date of the financial year for the company. + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. + sourceUrls: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + description: |- + 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). + createdDate: + $ref: '#/components/schemas/DateTime' + description: Date the linked company was created in the accounting software. + supplementalData: + $ref: '#/components/schemas/SupplementalData' + examples: + - 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' + AccountingCreateAccountResponse: + title: 'Accounting: Create account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankAccountResponse: + title: 'Accounting: Create bank account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankTransactions: + title: 'Accounting: Create bank account transactions' + type: object + properties: + accountId: + type: string + description: Unique identifier for a bank account. + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - '7110701885' + - EILBDVJVNUAGVKRQ + - Checking 0202 + transactions: + type: array + items: + $ref: '#/components/schemas/AccountingCreateBankTransactions/definitions/CreateBankAccountTransaction' + definitions: + CreateBankAccountTransaction: + title: Bank account transaction + type: object + properties: + id: + type: string + description: 'Identifier for the bank account transaction, unique for the company in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + date: + $ref: '#/components/schemas/DateTime' + description: + nullable: false + type: string + description: Description of the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + AccountingCreateBankTransactionsResponse: + title: 'Accounting: Create/update bank transaction response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingCreateBankTransactions' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateDirectCostResponse: + title: 'Accounting: Create direct cost response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingDirectCost' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreatePaymentResponse: + title: 'Accounting: Create payment response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingPayment' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateSupplierResponse: + title: 'Accounting: Create supplier response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingSupplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateTransferResponse: + title: 'Accounting: Create transfer response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingTransfer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreditNote: + title: 'Accounting: Credit note' + description: "## Overview\n\nThink of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.\n\nIn the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable. \n\nIt contains details of:\n* The amount of credit remaining and its status.\n* Payment allocations against the payments type, in this case an invoice.\n* Which customers the credit notes have been issued to." + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the credit note, unique to the company in the accounting software.' + creditNoteNumber: + type: string + nullable: true + description: Friendly reference for the credit note. + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the credit note has been issued to. + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: Total amount of credit that has been applied to the customer's accounts receivable + totalDiscount: + type: number + format: decimal + description: Any discounts applied to the credit note amount. + subTotal: + type: number + format: decimal + description: 'Value of the credit note, including discounts and excluding tax.' + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to credit note. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the credit note. + totalTaxAmount: + type: number + format: decimal + description: Any tax applied to the credit note amount. + discountPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of discounts applied to the credit note. + remainingCredit: + type: number + format: decimal + description: Unused balance of totalAmount originally raised. + status: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteStatus' + description: Current state of the credit note. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the credit note as recorded in the accounting system. + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the credit note was fully allocated. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + note: + type: string + nullable: true + description: 'Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - remainingCredit + - status + definitions: + creditNoteStatus: + title: Credit note status + description: Current state of the credit note. + type: string + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + creditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been issued.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been issued. + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The credit note is a direct income if `True`. + required: + - unitAmount + - quantity + examples: + - - id: 0316bd24-8a01-4a3a-a0e5-a73f14ebcbec + creditNoteNumber: '5239277' + customerRef: + id: b5511228-b9ef-4713-91b1-ad2cf60eadb1 + companyName: Tool Hire Company + totalAmount: 550 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 550 + status: Submitted + issueDate: '2018-03-28T21:28:58.249Z' + allocatedOnDate: null + note: More information available on request. + currency: USD + currencyRate: null + lineItems: + - description: Anvil10000Lb + unitAmount: 50 + quantity: 10 + discountAmount: 0 + subTotal: 500 + taxAmount: 50 + totalAmount: 550 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + name: null + discountPercentage: null + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: null + itemRef: + id: '1' + name: null + paymentAllocations: [] + modifiedDate: null + sourceModifiedDate: null + AccountingCreditNotes: + title: 'Accounting: Credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingCustomer: + title: 'Accounting: Customer' + description: | + ## 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). + + Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the customer, unique to the company in the accounting software.' + customerName: + type: string + nullable: true + description: 'Name of the customer as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the identified customer. + emailAddress: + type: string + nullable: true + description: Email address the customer can be contacted by. + defaultCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Default currency the transactional data of the customer is recorded in. + phone: + type: string + nullable: true + description: Phone number the customer can be contacted by. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + contacts: + type: array + nullable: true + description: An array of Contacts. + items: + $ref: '#/components/schemas/AccountingCustomer/definitions/contact' + registrationNumber: + type: string + nullable: true + description: 'Company number. In the UK, this is typically the Companies House company registration number.' + taxNumber: + type: string + nullable: true + description: Company tax number. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + description: Current state of the customer. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + accountingCustomerRef: + type: object + properties: + id: + minLength: 1 + type: string + description: '`id` from the Customers data type' + companyName: + type: string + nullable: true + description: '`customerName` from the Customer data type' + required: + - id + customerStatus: + description: Status of customer. + type: string + enum: + - Unknown + - Active + - Archived + contact: + type: object + properties: + name: + type: string + nullable: true + description: Name of a contact for a customer. + email: + type: string + nullable: true + description: Email of a contact for a customer. + phone: + type: array + nullable: true + description: An array of Phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + address: + $ref: '#/components/schemas/AccountingAddress' + description: An object of Address information. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + modifiedDate: + $ref: '#/components/schemas/DateTime' + required: + - status + AccountingCustomers: + title: 'Accounting: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCustomer' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectCost: + title: 'Accounting: Direct cost' + description: |- + > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software. + + ## Overview + + Direct costs are money that leave the business without impacting Accounts Payable, and refunds associated with such transactions. + + Direct costs include: + * Purchasing an item and paying it off at the point of the purchase + * Receiving cash from a refunded item if the refund is made by the supplier + + Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct cost, unique for the company.' + - $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + directCostPrototype: + type: object + properties: + reference: + type: string + nullable: true + description: User-friendly reference for the direct cost. + note: + type: string + nullable: true + description: A note attached to the direct cost. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct cost. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the direct cost as recorded in the accounting software.Date of the direct cost as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the direct cost. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostLineItem' + paymentAllocations: + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct costs, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct costs. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct costs, inclusive of tax.' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + directCostLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + Price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + Number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Collection of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountingDirectCost/definitions/tracking' + required: + - unitAmount + - quantity + tracking: + title: Invoiceable tracking + required: + - recordRefs + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + invoiceTo: + $ref: '#/components/schemas/AccountingRecordRef' + additionalProperties: false + invoiceTo: + type: object + title: Invoice to + description: Links to the customer the direct cost is associated. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + example: customers + AccountingDirectCosts: + title: 'Accounting: Direct costs' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectCost' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectIncome: + title: 'Accounting: Direct income' + description: "> **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software.\n\n## Overview\n\nDirect incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes made at the point of sale.\n\nDirect incomes include: \n\n- Selling an item directly to a contact, and receiving payment at the point of the sale.\n- Refunding an item sold at the point of sale in cash to a contact.\n\nDirect incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct income, unique for the company.' + reference: + type: string + nullable: true + description: User-friendly reference for the direct income. + note: + type: string + nullable: true + description: An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct income. + issueDate: + $ref: '#/components/schemas/DateTime' + description: The date of the direct income as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the direct income. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectIncome/definitions/directIncomeLineItem' + paymentAllocations: + type: array + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct incomes, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct incomes. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct incomes, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + definitions: + directIncomeLineItem: + type: object + properties: + description: + type: string + nullable: true + description: A user-friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + The price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + The number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'The amount of the line, inclusive of discounts, but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: |- + The amount of tax for the line. + Note: If the platform does not provide this information, the quantity will be mapped as 0.00. + totalAmount: + type: number + format: decimal + nullable: true + description: 'The total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + description: An array of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + required: + - unitAmount + - quantity + AccountingDirectIncomes: + title: 'Accounting: Direct incomes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectIncome' + - $ref: '#/components/schemas/PagingInfo' + AccountingInvoice: + title: 'Accounting: Invoice' + description: "> **Invoices or bills?**\n>\n> We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.\n>\n> See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills.\n\n## Overview\n\nAn invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer).\n\nIn Codat, an invoice contains details of:\n\n- The timeline of the invoice—when it was raised, marked as paid, last edited, and so on.\n- How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. \n- Who the invoice has been raised to; the _customer_.\n- The breakdown of what the invoice is for; the _line items_.\n- Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.\n\n> **Invoice PDF downloads** \n>\n> You can download a PDF version of an invoice for supported integrations.\n> \n> The filename will be invoice-{number}.pdf.\n\n> **Referencing an invoice in Sage 50 and ClearBooks**\n>\n> In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same." + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the invoice, unique to the company in the accounting software.' + invoiceNumber: + type: string + nullable: true + description: 'Friendly reference for the invoice. If available, this appears in the file name of invoice attachments.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the invoice has been issued to. + salesOrderRefs: + type: array + nullable: true + description: List of references to related Sales orders. + items: + title: Sales order reference + type: object + properties: + id: + type: string + description: Unique identifier to a record in `dataType`. + dataType: + type: string + description: The underlying data type associated to the reference `id`. + enum: + - salesOrders + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the invoice as recorded in the accounting system. + dueDate: + $ref: '#/components/schemas/DateTime' + description: Date the customer is due to be paid by. + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: 'Date the invoice was marked as paid in the accounting system. If this field is not available from the accounting software, it is calculated by Codat using associated payments.' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the invoice. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalDiscount: + type: number + format: decimal + nullable: true + description: Numerical value of discounts applied to the invoice. + subTotal: + type: number + format: decimal + nullable: true + description: Total amount of the invoice excluding any taxes. + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to invoice. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the invoice. + totalTaxAmount: + type: number + format: decimal + description: Amount of tax on the invoice. + totalAmount: + type: number + format: decimal + description: 'Amount of the invoice, inclusive of tax.' + amountDue: + type: number + format: decimal + description: Amount outstanding on the invoice. + discountPercentage: + type: number + format: decimal + nullable: true + description: 'Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`.' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + note: + type: string + nullable: true + description: 'Any additional information about the invoice. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - totalTaxAmount + - totalAmount + - amountDue + - status + definitions: + invoiceLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services provided. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services provided. + discountAmount: + type: number + format: decimal + nullable: true + description: Numerical value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate (from 0 to 100) of any discounts applied to the unit amount. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The invoice is a direct income if `True`. + required: + - unitAmount + - quantity + invoiceStatus: + type: string + enum: + - Unknown + - Draft + - Submitted + - PartiallyPaid + - Paid + - Void + description: |- + Current state of the invoice: + + - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email. + - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld). + - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`. + - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`. + - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. + AccountingInvoices: + title: 'Accounting: Invoices' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingInvoice' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournal: + title: 'Accounting: Journal' + description: | + > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type + + ## Overview + + In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. + + When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. + + Such journals can be divided into two categories: + + - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. + - General journals: journals used to record transactions that fall outside the scope of the special journals. + + Multiple journals or subjournals are used in the following Codat integrations: + + - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) + - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) + - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) + + > When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Journal ID. + - $ref: '#/components/schemas/AccountingJournal/definitions/journalPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalPrototype: + type: object + properties: + journalCode: + type: string + nullable: true + description: Native journal number or code. + name: + type: string + nullable: true + description: |- + Journal name. + The maximum length for a journal name is 256 characters. All characters above that number will be truncated. + type: + type: string + nullable: true + description: The type of the journal. + parentId: + type: string + nullable: true + description: |- + Parent journal ID. + If the journal is a parent journal, this value is not present. + hasChildren: + type: boolean + description: 'If the journal has child journals, this value is true. If it doesn’t, it is false.' + createdOn: + $ref: '#/components/schemas/DateTime' + description: Journal creation date. + status: + $ref: '#/components/schemas/AccountingJournal/definitions/journalStatus' + journalRef: + title: Journal reference + type: object + additionalProperties: false + description: Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). + properties: + id: + minLength: 1 + type: string + description: GUID of the underlying journal. + name: + type: string + maxLength: 256 + nullable: true + description: Name of journal + required: + - id + journalStatus: + type: string + description: Current journal status. + enum: + - Unknown + - Active + - Archived + AccountingJournalEntries: + title: 'Accounting: Journal entries' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournalEntry: + title: 'Accounting: Journal entry' + description: "> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type\n\n## Overview\n\nA journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.\n\nA journal entry line item is a single transaction line on the journal entry. For example: \n\n- When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. \n- When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.\n\nIn Codat a journal entry contains details of:\n\n- The date on which the entry was created and posted.\n- Itemised lines, including amounts and currency.\n- A reference to the associated accounts.\n- A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. \n\n> **Pushing journal entries** \n> Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency." + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier of the journal entry for the company in the accounting software. + description: + type: string + nullable: true + description: Optional description of the journal entry. + postedOn: + $ref: '#/components/schemas/DateTime' + description: |- + Date on which the journal entry was posted to the accounting software, and had an impact on the general ledger. This may be different from the creation date. + + For example, a user creates a journal entry on Monday and saves it as draft, which has no impact on the general ledger. On Thursday, they return to the entry and post it. + + The **createdOn** date shows as Monday. + The **postedOn** date shows as Thursday. + Journal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date. + createdOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was created in the accounting software. + updatedOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was last updated in the accounting software. + journalRef: + $ref: '#/components/schemas/AccountingJournal/definitions/journalRef' + journalLines: + type: array + nullable: true + description: An array of journal lines. + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine' + recordRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalEntryRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the journal line item. + netAmount: + type: number + format: decimal + description: 'Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.' + transactionAmount: + type: number + format: decimal + description: The amount in the original transaction currency. + currency: + type: string + nullable: true + description: Currency for the journal line item. + transactionCurrency: + type: string + nullable: true + description: Currency of the original transaction. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + tracking: + description: 'List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)' + title: Tracking + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + nullable: true + definitions: + trackingRecordRef: + type: object + title: Record reference + description: Links to the customer or tracking category. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + - suppliers + - trackingCategories + example: trackingCategories + contactRef: + title: Contact reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for a customer or supplier. + dataType: + type: string + nullable: true + description: Allowed name of the 'dataType'. + enum: + - customers + - suppliers + required: + - id + required: + - netAmount + journalEntryRecordRef: + type: object + title: Record reference + description: Links a journal entry to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingJournals: + title: 'Accounting: Journals' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournal' + - $ref: '#/components/schemas/PagingInfo' + AccountingPayment: + title: 'Accounting: Payment' + description: "\uFEFF\x3E\x20\x2A\x2A\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x6F\x72\x20\x62\x69\x6C\x6C\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x3F\x2A\x2A\n\x3E\n\x3E\x20\x20\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x6F\x6E\x6C\x79\x2E\x20\x46\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x70\x61\x79\x61\x62\x6C\x65\x2C\x20\x73\x65\x65\x20\x5B\x62\x69\x6C\x6C\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x69\x6C\x6C\x50\x61\x79\x6D\x65\x6E\x74\x29\x2E\x20\x54\x68\x65\x73\x65\x20\x69\x6E\x63\x6C\x75\x64\x65\x20\x5B\x62\x69\x6C\x6C\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x69\x6C\x6C\x29\x20\x61\x6E\x64\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x62\x69\x6C\x6C\x73\x2E\n\n\x23\x23\x20\x4F\x76\x65\x72\x76\x69\x65\x77\n\n\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x69\x6E\x63\x6C\x75\x64\x65\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x20\x64\x61\x74\x61\x2E\x20\x54\x68\x69\x73\x20\x69\x6E\x63\x6C\x75\x64\x65\x73\x20\x5B\x69\x6E\x76\x6F\x69\x63\x65\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x49\x6E\x76\x6F\x69\x63\x65\x29\x20\x61\x6E\x64\x20\x5B\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\x29\x2E\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x6E\x20\x43\x6F\x64\x61\x74\x20\x75\x73\x75\x61\x6C\x6C\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x6E\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x6D\x6F\x6E\x65\x79\x20\x77\x69\x74\x68\x69\x6E\x20\x61\x6E\x79\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\x20\x54\x68\x69\x73\x20\x69\x6E\x63\x6C\x75\x64\x65\x73\x2C\x20\x62\x75\x74\x20\x69\x73\x20\x6E\x6F\x74\x20\x73\x74\x72\x69\x63\x74\x6C\x79\x20\x6C\x69\x6D\x69\x74\x65\x64\x20\x74\x6F\x3A\n\n\x2D\x20\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x64\x65\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x2C\x20\x6C\x69\x6B\x65\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x63\x61\x72\x64\x2C\x20\x63\x68\x65\x71\x75\x65\x2C\x20\x6F\x72\x20\x63\x61\x73\x68\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\x2D\x20\x41\x6E\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x61\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x27\x73\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x2C\x20\x65\x69\x74\x68\x65\x72\x20\x74\x6F\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x6F\x72\x20\x6D\x61\x79\x62\x65\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x2E\n\x2D\x20\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x64\x65\x20\x64\x69\x72\x65\x63\x74\x6C\x79\x20\x74\x6F\x20\x74\x68\x61\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\x20\x54\x68\x69\x73\x20\x6D\x69\x67\x68\x74\x20\x62\x65\x20\x61\x6E\x20\x6F\x76\x65\x72\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x72\x20\x61\x20\x70\x72\x65\x70\x61\x79\x6D\x65\x6E\x74\x2E\x20\x49\x74\x20\x6D\x69\x67\x68\x74\x20\x61\x6C\x73\x6F\x20\x62\x65\x20\x74\x68\x65\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x66\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x64\x65\x20\x64\x69\x72\x65\x63\x74\x6C\x79\x20\x74\x6F\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\n\x44\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x75\x6E\x64\x65\x72\x6C\x79\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x2C\x20\x73\x6F\x6D\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x79\x70\x65\x73\x20\x6D\x61\x79\x20\x62\x65\x20\x63\x6F\x6D\x62\x69\x6E\x65\x64\x2E\x20\x50\x6C\x65\x61\x73\x65\x20\x73\x65\x65\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x64\x65\x74\x61\x69\x6C\x73\x2E\n\n\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x64\x65\x74\x61\x69\x6C\x73\x20\x6F\x66\x3A\n\n\x2D\x20\x57\x68\x65\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x61\x73\x20\x72\x65\x63\x6F\x72\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x79\x73\x74\x65\x6D\x2E\n\x2D\x20\x48\x6F\x77\x20\x6D\x75\x63\x68\x20\x69\x74\x20\x69\x73\x20\x66\x6F\x72\x20\x61\x6E\x64\x20\x69\x6E\x20\x77\x68\x61\x74\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x74\x68\x61\x74\x20\x61\x6D\x6F\x75\x6E\x74\x20\x69\x73\x20\x69\x6E\x2E\n\x2D\x20\x57\x68\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x61\x73\x20\x5F\x70\x61\x69\x64\x20\x62\x79\x5F\x20\u2013\x20\x74\x68\x65\x20\x5F\x63\x75\x73\x74\x6F\x6D\x65\x72\x5F\x2E\n\x2D\x20\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x65\x74\x68\x6F\x64\x20\x75\x73\x65\x64\x2E\n\x2D\x20\x54\x68\x65\x20\x62\x72\x65\x61\x6B\x64\x6F\x77\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x74\x79\x70\x65\x73\x20\x6F\x66\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\u2013\x20\x74\x68\x65\x20\x5F\x6C\x69\x6E\x65\x20\x69\x74\x65\x6D\x73\x5F\x2E\n\n\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x69\x73\x20\x61\x20\x63\x68\x69\x6C\x64\x20\x64\x61\x74\x61\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x5B\x61\x63\x63\x6F\x75\x6E\x74\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x41\x63\x63\x6F\x75\x6E\x74\x54\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x29\x2E\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x20\x74\x79\x70\x65\x73\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x70\x61\x79\x69\x6E\x67\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x60\x6C\x69\x6E\x65\x73\x60\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x69\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x5F\x61\x6D\x6F\x75\x6E\x74\x5F\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x6E\x20\x60\x49\x6E\x76\x6F\x69\x63\x65\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x2E\x20\x54\x68\x65\x20\x73\x75\x6D\x20\x6F\x66\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2E\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2E\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6D\x75\x73\x74\x20\x65\x71\x75\x61\x6C\x20\x60\x30\x60\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\n\n\x41\x20\x73\x69\x6E\x67\x6C\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x63\x61\x6E\x20\x70\x61\x79\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x2E\x20\x54\x68\x69\x73\x20\x63\x61\x6E\x20\x62\x65\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x65\x64\x20\x69\x6E\x20\x6F\x6E\x65\x20\x6F\x66\x20\x74\x77\x6F\x20\x66\x6F\x72\x6D\x61\x74\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x68\x6F\x77\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x6B\x65\x65\x70\x73\x20\x74\x68\x65\x69\x72\x20\x62\x6F\x6F\x6B\x73\x3A\n\n\x2D\x20\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x68\x61\x73\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x65\x6E\x74\x72\x69\x65\x73\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x2C\x20\x6F\x6E\x65\x20\x66\x6F\x72\x20\x65\x61\x63\x68\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x69\x73\x20\x70\x61\x69\x64\x2E\x20\x45\x61\x63\x68\x20\x6C\x69\x6E\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x73\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x20\x61\x6E\x64\x20\x72\x75\x6C\x65\x73\x20\x64\x65\x73\x63\x72\x69\x62\x65\x64\x20\x69\x6E\x20\x5B\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x5D\x28\x23\x70\x61\x79\x6D\x65\x6E\x74\x2D\x6F\x66\x2D\x61\x6E\x2D\x69\x6E\x76\x6F\x69\x63\x65\x29\x2E\n\x2D\x20\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x68\x61\x73\x20\x61\x20\x6C\x69\x6E\x65\x20\x77\x69\x74\x68\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x6C\x69\x6E\x6B\x73\x20\x74\x6F\x20\x65\x61\x63\x68\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\x20\x54\x68\x69\x73\x20\x6F\x63\x63\x75\x72\x73\x20\x77\x68\x65\x6E\x20\x74\x68\x65\x20\x70\x72\x6F\x70\x6F\x72\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x6F\x72\x69\x67\x69\x6E\x61\x6C\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x61\x6C\x6C\x6F\x63\x61\x74\x65\x64\x20\x74\x6F\x20\x65\x61\x63\x68\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x69\x73\x20\x6E\x6F\x74\x20\x61\x76\x61\x69\x6C\x61\x62\x6C\x65\x2E\n\n\x45\x61\x63\x68\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x61\x73\x20\x74\x68\x6F\x73\x65\x20\x64\x65\x73\x63\x72\x69\x62\x65\x64\x20\x69\x6E\x20\x5B\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x5D\x28\x23\x70\x61\x79\x6D\x65\x6E\x74\x2D\x6F\x66\x2D\x61\x6E\x2D\x69\x6E\x76\x6F\x69\x63\x65\x29\x2C\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x69\x6E\x64\x69\x63\x61\x74\x69\x6E\x67\x20\x68\x6F\x77\x20\x6D\x75\x63\x68\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x61\x73\x20\x61\x6C\x6C\x6F\x63\x61\x74\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\x20\x54\x68\x65\x20\x73\x75\x6D\x20\x6F\x66\x20\x6C\x69\x6E\x65\x20\x61\x6D\x6F\x75\x6E\x74\x73\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x61\x6E\x64\x20\x72\x65\x66\x75\x6E\x64\x73\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x2C\x20\x74\x68\x61\x74\x20\x69\x73\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x64\x6F\x65\x73\x6E\u2019\x74\x20\x70\x61\x79\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x69\x6E\x76\x6F\x69\x63\x65\x2C\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x6C\x69\x6E\x65\x73\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x70\x61\x69\x64\x20\x62\x79\x20\x61\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x6F\x72\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x6D\x20\x62\x79\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2E\x20\x41\x20\x72\x65\x66\x75\x6E\x64\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x6C\x69\x6E\x6B\x2E\x20\x46\x6F\x72\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x69\x73\x20\x69\x73\x20\x60\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\x60\x2E\x20\x46\x6F\x72\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x20\x74\x68\x69\x73\x20\x69\x73\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x2E\n\x2D\x20\x54\x68\x65\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x2E\n\x2D\x20\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x20\x69\x73\x20\x60\x30\x60\x20\u2013\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x5F\x6F\x72\x5F\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x72\x20\x72\x65\x66\x75\x6E\x64\x2E\n\n\x49\x74\x20\x69\x73\x20\x70\x6F\x73\x73\x69\x62\x6C\x65\x20\x74\x6F\x20\x68\x61\x76\x65\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x69\x73\x20\x70\x61\x72\x74\x20\x5F\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x5F\x20\x61\x6E\x64\x20\x70\x61\x72\x74\x20\x5F\x61\x6C\x6C\x6F\x63\x61\x74\x65\x64\x5F\x20\x74\x6F\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\x20\x45\x61\x63\x68\x20\x6C\x69\x6E\x65\x20\x73\x68\x6F\x75\x6C\x64\x20\x66\x6F\x6C\x6C\x6F\x77\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\x20\x61\x62\x6F\x76\x65\x2E\n\n\x23\x23\x20\x55\x73\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x74\x6F\x20\x70\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\n\n\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x75\x73\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x69\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x6D\x6F\x6E\x65\x79\x20\x6D\x6F\x76\x65\x64\x2C\x20\x77\x68\x69\x63\x68\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x69\x73\x20\x60\x30\x60\x2C\x20\x61\x73\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x61\x6E\x64\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6D\x75\x73\x74\x20\x62\x61\x6C\x61\x6E\x63\x65\x20\x65\x61\x63\x68\x20\x6F\x74\x68\x65\x72\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x74\x77\x6F\x20\x65\x6C\x65\x6D\x65\x6E\x74\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x54\x68\x65\x20\x66\x69\x72\x73\x74\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x20\x68\x61\x73\x3A\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x6E\x20\x60\x49\x6E\x76\x6F\x69\x63\x65\x60\x2E\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\n\x20\x20\x20\x20\x2D\x20\x54\x68\x65\x20\x73\x65\x63\x6F\x6E\x64\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x20\x68\x61\x73\x3A\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\x60\x2E\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x75\x73\x65\x64\x20\x62\x79\x20\x74\x68\x69\x73\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x23\x23\x20\x52\x65\x66\x75\x6E\x64\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x72\x65\x66\x75\x6E\x64\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x69\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x20\x66\x6F\x72\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x66\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x2E\x20\x54\x68\x65\x73\x65\x20\x61\x72\x65\x20\x62\x6F\x74\x68\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2C\x20\x61\x73\x20\x74\x68\x69\x73\x20\x69\x73\x20\x6D\x6F\x6E\x65\x79\x20\x6C\x65\x61\x76\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x2E\n\n\x23\x23\x20\x52\x65\x66\x75\x6E\x64\x69\x6E\x67\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\n\n\x49\x66\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2C\x20\x66\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x69\x66\x20\x61\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x6F\x76\x65\x72\x70\x61\x69\x64\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x6F\x76\x65\x72\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x20\x72\x65\x74\x75\x72\x6E\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x2C\x20\x74\x68\x65\x72\x65\x20\x61\x72\x65\x20\x74\x77\x6F\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x72\x65\x63\x6F\x72\x64\x73\x3A\n\n\x2D\x20\x4F\x6E\x65\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x69\x6E\x63\x6F\x6D\x69\x6E\x67\x20\x6F\x76\x65\x72\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\x2D\x20\x41\x6E\x6F\x74\x68\x65\x72\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x6F\x75\x74\x67\x6F\x69\x6E\x67\x20\x72\x65\x66\x75\x6E\x64\x2E\n\n\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x73\x75\x69\x6E\x67\x20\x74\x68\x65\x20\x72\x65\x66\x75\x6E\x64\x20\x68\x61\x73\x20\x61\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x2E\x20\x54\x68\x69\x73\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x61\x6C\x73\x6F\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x6C\x69\x6E\x65\x73\x20\x61\x72\x72\x61\x79\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x50\x61\x79\x6D\x65\x6E\x74\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x61\x6E\x64\x20\x69\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2C\x20\x61\x73\x20\x74\x68\x69\x73\x20\x69\x73\x20\x6D\x6F\x6E\x65\x79\x20\x6C\x65\x61\x76\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x2E\n\n\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x68\x61\x73\x20\x61\x20\x6C\x69\x6E\x65\x20\x77\x68\x65\x72\x65\x20\x74\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x69\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x20\x69\x73\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x2E\x20\x54\x68\x69\x73\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x73\x65\x76\x65\x72\x61\x6C\x20\x65\x6E\x74\x72\x69\x65\x73\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x69\x66\x20\x69\x74\x20\x77\x61\x73\x20\x75\x73\x65\x64\x20\x74\x6F\x20\x70\x61\x72\x74\x6C\x79\x20\x70\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\n\n\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x3A\x20\x41\x20\xA3\x31\x2C\x30\x35\x30\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x20\xA3\x31\x2C\x30\x30\x30\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x77\x69\x74\x68\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x66\x20\xA3\x35\x30\x20\x68\x61\x73\x20\x74\x77\x6F\x20\x6C\x69\x6E\x65\x73\x3A\n\n\x2D\x20\x4F\x6E\x65\x20\x66\x6F\x72\x20\xA3\x31\x2C\x30\x30\x30\x20\x6C\x69\x6E\x6B\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\n\x2D\x20\x41\x6E\x6F\x74\x68\x65\x72\x20\x66\x6F\x72\x20\xA3\x35\x30\x20\x6C\x69\x6E\x6B\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x74\x68\x65\x20\x6F\x76\x65\x72\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x61\x2A\x2A\x20\x74\x79\x70\x65\x2A\x2A\x20\x6F\x66\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x20\x61\x6E\x64\x20\x61\x6E\x20\x49\x44\x20\x74\x68\x61\x74\x20\x63\x6F\x72\x72\x65\x73\x70\x6F\x6E\x64\x73\x20\x74\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x6C\x69\x6E\x6B\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x20\x61\x73\x20\x69\x74\x73\x20\x6D\x6F\x6E\x65\x79\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x61\x64\x64\x65\x64\x20\x74\x6F\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x2E\x20\x49\x74\x27\x73\x20\x62\x61\x6C\x61\x6E\x63\x65\x64\x20\x6F\x75\x74\x20\x62\x79\x20\x74\x68\x65\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x66\x75\x6E\x64\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x74\x68\x69\x73\x20\x6C\x69\x6E\x65\x2E\n\n\x3E\x20\x2A\x2A\x53\x75\x70\x70\x6F\x72\x74\x20\x66\x6F\x72\x20\x6C\x69\x6E\x6B\x65\x64\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x2A\x2A\n\x3E\n\x3E\x20\x4E\x6F\x74\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x73\x75\x70\x70\x6F\x72\x74\x20\x6C\x69\x6E\x6B\x69\x6E\x67\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x77\x61\x79\x2E\x20\x49\x6E\x20\x73\x6F\x6D\x65\x20\x70\x6C\x61\x74\x66\x6F\x72\x6D\x73\x2C\x20\x79\x6F\x75\x20\x6D\x61\x79\x20\x73\x65\x65\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x61\x6E\x64\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\n\x23\x23\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x63\x75\x72\x72\x65\x6E\x63\x69\x65\x73\n\n\x54\x68\x65\x72\x65\x20\x61\x72\x65\x20\x74\x77\x6F\x20\x74\x79\x70\x65\x73\x20\x6F\x66\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x20\x74\x68\x61\x74\x20\x61\x72\x65\x20\x69\x6E\x63\x6C\x75\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x64\x61\x74\x61\x20\x74\x79\x70\x65\x3A\n\n\x50\x61\x79\x6D\x65\x6E\x74\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x3A\n\n\x2D\x20\x42\x61\x73\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\x2D\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x50\x61\x79\x6D\x65\x6E\x74\x20\x6C\x69\x6E\x65\x20\x6C\x69\x6E\x6B\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x3A\n\n\x2D\x20\x42\x61\x73\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x74\x65\x6D\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x2E\n\x2D\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x54\x68\x65\x73\x65\x20\x74\x77\x6F\x20\x72\x61\x74\x65\x73\x20\x61\x6C\x6C\x6F\x77\x20\x74\x68\x65\x20\x63\x61\x6C\x63\x75\x6C\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6C\x6F\x73\x73\x20\x6F\x72\x20\x67\x61\x69\x6E\x20\x66\x6F\x72\x20\x61\x6E\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x20\x61\x66\x66\x65\x63\x74\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6C\x69\x6E\x65\x73\x2E\x20\x54\x68\x65\x20\x73\x65\x63\x6F\x6E\x64\x20\x72\x61\x74\x65\x20\x69\x73\x20\x75\x73\x65\x64\x20\x77\x68\x65\x6E\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x20\x61\x70\x70\x6C\x69\x65\x64\x20\x74\x6F\x20\x61\x6E\x20\x69\x74\x65\x6D\x20\x69\x6E\x20\x61\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x74\x68\x61\x74\x20\x64\x6F\x65\x73\x6E\x27\x74\x20\x6D\x61\x74\x63\x68\x20\x65\x69\x74\x68\x65\x72\x3A\n\n\x2D\x20\x54\x68\x65\x20\x62\x61\x73\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\x2D\x20\x54\x68\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x74\x65\x6D\x2E\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x43\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x31\x32\x33\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6E\x6F\x74\x65\"\x3A\x20\"\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x39\x39\x2E\x39\x39\x2C\n\x20\x20\x20\x20\x20\x20\"\x63\x75\x72\x72\x65\x6E\x63\x79\"\x3A\x20\"\x47\x42\x50\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x39\x39\x2E\x39\x39\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x31\x37\x38\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x35\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x63\x75\x72\x72\x65\x6E\x63\x79\x52\x61\x74\x65\"\x3A\x20\x20\x31\x2E\x39\x39\x39\x38\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x23\x23\x20\x45\x78\x61\x6D\x70\x6C\x65\x20\x64\x61\x74\x61\n\n\x3E\x20\x2A\x2A\x4F\x62\x6A\x65\x63\x74\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x2A\x2A\n\x3E\n\x3E\x20\x46\x6F\x72\x20\x74\x68\x65\x20\x73\x61\x6B\x65\x20\x6F\x66\x20\x62\x72\x65\x76\x69\x74\x79\x2C\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\x20\x68\x65\x72\x65\x20\x6D\x61\x79\x20\x6F\x6D\x69\x74\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x66\x72\x6F\x6D\x20\x6F\x62\x6A\x65\x63\x74\x73\x2E\x20\x46\x6F\x72\x20\x74\x68\x65\x20\x66\x75\x6C\x6C\x20\x6F\x62\x6A\x65\x63\x74\x20\x64\x65\x66\x69\x6E\x69\x74\x69\x6F\x6E\x2C\x20\x73\x65\x65\x20\x5B\x50\x61\x79\x6D\x65\x6E\x74\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x61\x70\x69\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x77\x61\x67\x67\x65\x72\x2F\x69\x6E\x64\x65\x78\x2E\x68\x74\x6D\x6C\x23\x2F\x50\x61\x79\x6D\x65\x6E\x74\x73\x29\x2E\n\n\x23\x23\x20\x53\x69\x6D\x70\x6C\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x50\x61\x79\x6D\x65\x6E\x74\x20\x66\x6F\x72\x20\x69\x6E\x76\x6F\x69\x63\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x41\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x6E\x64\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x52\x65\x66\x75\x6E\x64\x20\x6F\x66\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x52\x65\x66\x75\x6E\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x4C\x69\x6E\x6B\x65\x64\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x70\x61\x79\x6D\x65\x6E\x74\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x52\x65\x66\x75\x6E\x64\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x70\x61\x79\x6D\x65\x6E\x74\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x55\x73\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x61\x6E\x64\x20\x63\x61\x73\x68\x20\x74\x6F\x20\x70\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x35\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x20\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x35\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x32\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x23\x23\x20\x43\x6F\x6D\x70\x6C\x65\x78\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x55\x73\x65\x20\x74\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x31\x30\x30\x30\x20\x69\x6E\x20\x74\x6F\x20\"\x62\x61\x6E\x6B\"\x20\x28\x63\x61\x73\x68\x2C\x20\x63\x68\x65\x71\x75\x65\x20\x65\x74\x63\x2E\x29\x20\x74\x6F\x20\x70\x61\x79\x20\x69\x6E\x76\x6F\x69\x63\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x50\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x77\x69\x74\x68\x20\x74\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x63\x61\x73\x68\x2C\x20\x77\x69\x74\x68\x20\x31\x30\x30\x30\x20\x6C\x65\x66\x74\x20\x27\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x27\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x63\x75\x73\x74\x6F\x6D\x65\x72\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x54\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x70\x61\x79\x20\x74\x77\x6F\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x61\x6D\x6F\x75\x6E\x74\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x77\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x54\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x63\x61\x73\x68\x20\x70\x61\x79\x20\x74\x68\x72\x65\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x61\x6D\x6F\x75\x6E\x74\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x2C\x20\x61\x6E\x64\x20\x72\x65\x66\x75\x6E\x64\x20\x63\x61\x73\x68\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x77\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x75\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x52\x65\x66\x75\x6E\x64\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x70\x61\x79\x6D\x65\x6E\x74\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x49\x6E\x20\x74\x68\x69\x73\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x73\x20\x75\x73\x65\x64\x20\x74\x6F\x20\x70\x61\x79\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x69\x6E\x20\x4A\x61\x6E\x75\x61\x72\x79\x20\x61\x6E\x64\x20\x61\x67\x61\x69\x6E\x20\x69\x6E\x20\x46\x65\x62\x72\x75\x61\x72\x79\x2E\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x4A\x61\x6E\x75\x61\x72\x79\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x64\x61\x74\x65\"\x20\x3A\x20\"\x31\x39\x30\x31\x2D\x30\x31\x2D\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\x2D\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x34\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\x2D\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x34\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x46\x65\x62\x72\x75\x61\x72\x79\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x64\x61\x74\x65\"\x20\x3A\x20\"\x31\x39\x30\x31\x2D\x30\x32\x2D\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\x2D\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\x2D\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x33\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\x2D\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x33\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x54\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x73\x6F\x6D\x65\x20\x63\x61\x73\x68\x20\x70\x61\x79\x20\x74\x77\x6F\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x73\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x61\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x62\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the payment, unique to the company in the accounting software.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Customer the payment is recorded against in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is recorded against in the accounting software. + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + description: The Payment Method to which the payment is linked in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: ISO currency code recorded for the payment in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + $ref: '#/components/schemas/DateTime' + description: Date the payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Any additional information associated with the payment. + lines: + type: array + nullable: true + description: An array of payment lines. + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLine' + reference: + type: string + nullable: true + description: Friendly reference for the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + paymentLine: + title: Payment Line + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + required: + - amount + paymentLineLink: + title: Payment Line Link + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLinkType' + id: + type: string + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: "Amount by which the balance of the linked entity is altered, in the currency of the linked entity. \nA negative link amount _reduces_ the outstanding amount on the accounts receivable account. \nA positive link amount _increases_ the outstanding amount on the accounts receivable account." + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + paymentLinkType: + title: Payment Link Type + type: string + enum: + - Unknown + - Unlinked + - Invoice + - CreditNote + - Other + - Refund + - Payment + - PaymentOnAccount + - ManualJournal + - Discount + description: "Types of payment line links, either: \n`Unknown` \n`Unlinked` - Not used \n`Invoice` - ID refers to the invoice \n`CreditNote` - ID refers to the credit note \n`Refund` - ID refers to the sibling payment \n`Payment` - ID refers to the sibling payment \n`PaymentOnAccount` - ID refers to the customer \n`Other` - ID refers to the customer \n`Manual Journal` \n`Discount` - ID refers to the payment" + AccountingPaymentAllocation: + title: 'Accounting: Payment allocation' + type: object + properties: + payment: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment' + allocation: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + totalAmount: + type: number + format: decimal + description: The total amount that has been allocated. + required: + - payment + - allocation + definitions: + paymentAllocationPayment: + type: object + properties: + id: + type: string + description: Identifier of the allocated payment. + note: + type: string + nullable: true + description: Notes attached to the allocated payment. + reference: + type: string + nullable: true + description: Reference to the allocated payment. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: The account that the allocated payment is made from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency the payment has been made in. + currencyRate: + title: Currency rate + type: number + format: decimal + nullable: true + description: "Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.\n\nCurrency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. \n\nIt 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.\n\nWhere 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). \n\nFor accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.\n\n## Examples with base currency of GBP\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **USD** | $20 | 0.781 | £15.62 |\n| **EUR** | €20 | 0.885 | £17.70 |\n| **RUB** | ₽20 | 0.011 | £0.22 |\n\n## Examples with base currency of USD\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **GBP** | £20 | 1.277 | $25.54 |\n| **EUR** | €20 | 1.134 | $22.68 |\n| **RUB** | ₽20 | 0.015 | $0.30 |\n\n\n### Integration-specific details\n\n| Integration | Scenario | System behavior |\n|-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 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. |" + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was paid. + totalAmount: + type: number + format: decimal + description: Total amount that was paid. + AccountingPaymentMethod: + title: 'Accounting: Payment method' + description: |- + ## Overview + + A Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/lending-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier for the payment method. + name: + type: string + nullable: true + description: Name of the payment method. + type: + $ref: '#/components/schemas/AccountingPaymentMethod/definitions/paymentMethodType' + status: + $ref: '#/components/schemas/CommercePaymentMethod/allOf/1/properties/status' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentMethodType: + description: Method of payment. + type: string + enum: + - Unknown + - Cash + - Check + - CreditCard + - DebitCard + - BankTransfer + - Other + AccountingPayments: + title: 'Accounting: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingProfitAndLossReport: + title: 'Accounting: Profit and loss report' + description: "> **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).\n\n## Overview\n\nThe purpose of a profit and loss report is to present the financial performance of a company over a specified time period.\n\nA profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made.\n\n> **Profit and loss or balance sheet?** \n> Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date.\n\n\n**Structure of this report** \nThis report will reflect the structure and line descriptions that the business has set in their own accounting software.\n\n**History** \nBy default, Codat pulls (up to) 24 months of profit and loss history for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `profitAndLoss` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/post-profile-syncSettings).\n\n**Want to pull this in a standardised structure?** \nOur [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers." + type: object + properties: + reports: + type: array + description: An array of profit and loss reports. + items: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/profitAndLossReport' + reportBasis: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/reportBasis' + currency: + type: string + description: Base currency of the company in which the profit and loss report is presented. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Earliest available monthly report data. + required: + - reports + - reportBasis + definitions: + reportBasis: + enum: + - Unknown + - Accrual + - Cash + type: string + description: The basis of a report. + profitAndLossReport: + type: object + additionalProperties: false + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Date from which the report data begins. + toDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the report data ends. + income: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for income in the given date range. + costOfSales: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for cost of sales in the given date range. + grossProfit: + type: number + format: decimal + description: Gross profit of the company in the given date range. + expenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for expenses in the given date range. + netOperatingProfit: + type: number + format: decimal + description: Net operating profit of the company in the given date range. + otherExpenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other expenses in the given date range. + otherIncome: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other income in the given date range. + netOtherIncome: + type: number + format: decimal + description: Net other income of the company in the given date range. + netProfit: + type: number + format: decimal + description: Net profit of the company in the given date range. + required: + - grossProfit + - netOperatingProfit + - netOtherIncome + - netProfit + AccountingRecordRef: + type: object + x-internal: true + title: Record reference + description: "Links the current record to the underlying record or data type that created it. \n\nFor example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. " + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Allowed name of the 'dataType'. + examples: + - journalEntry + - invoice + - accountTransaction + - transfer + AccountingSupplier: + title: 'Accounting: Supplier' + description: |- + ## Overview + + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: + type: string + nullable: true + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the supplier. + emailAddress: + type: string + nullable: true + description: Email address that the supplier may be contacted on. + phone: + type: string + nullable: true + description: Phone number that the supplier may be contacted on. + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + registrationNumber: + type: string + nullable: true + description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' + taxNumber: + type: string + nullable: true + description: Supplier's company tax number. + status: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierStatus' + defaultCurrency: + type: string + nullable: true + description: Default currency the supplier's transactional data is recorded in. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. + type: object + properties: + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. + type: string + enum: + - Unknown + - Active + - Archived + examples: + - 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' + AccountingSuppliers: + title: Suppliers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingSupplier' + - $ref: '#/components/schemas/PagingInfo' + AccountingTrackingCategory: + x-internal: true + title: 'Accounting: Tracking category' + description: "Details of a category used for tracking transactions.\n\n> Language tip\n>\n> Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting software. In Codat, we refer to these as tracking categories.\n\n## Overview\n\nTracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers.\n\nFrom their accounting system, customers can: \n\n- Create and maintain tracking categories and tracking category types.\n- View all tracking categories that are available for use.\n- View the relationships between the categories.\n- Assign invoices, bills, credit notes, or bill credit notes to one or more categories.\n- View the categories that a transaction belongs to.\n- View all transactions in a tracking category.\n\n### Tracking categories per platform\n\nReview the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. \n\n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
\n\n> **Example use case**\n>\n> Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**.\n\nIf a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. " + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'The identifier for the item, unique per tracking category.' + nullable: true + name: + type: string + description: The name of the tracking category. + nullable: true + status: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/status' + parentId: + type: string + description: The identifier for this item's immediate parent. + nullable: true + hasChildren: + type: boolean + description: Boolean value indicating whether this category has SubCategories. + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + trackingCategoryRef: + required: + - id + type: object + description: References a category against which the item is tracked. + deprecated: true + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the tracking category. + name: + type: string + nullable: true + description: Name of tracking category. + status: + title: Tracking category status + type: string + description: Current state of the tracking category. + enum: + - Unknown + - Active + - Archived + examples: + - id: string + name: string + status: Unknown + parentId: string + hasChildren: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + AccountingTransfer: + title: 'Accounting: Transfer' + description: 'A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).' + allOf: + - properties: + id: + type: string + description: Unique identifier for the transfer. + description: + type: string + nullable: true + description: Description of the transfer. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: 'The customer or supplier for the transfer, if available.' + date: + $ref: '#/components/schemas/DateTime' + description: The day on which the transfer was made. + from: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving from. + to: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving to. + status: + description: The status of the transfer in the account + type: string + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + nullable: true + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories this transfer is being tracked against. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + depositedRecordRefs: + type: array + nullable: true + description: List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. + items: + $ref: '#/components/schemas/AccountingRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + transferAccount: + title: Transfer account + description: Account details of the account sending or receiving the transfer. + type: object + properties: + accountRef: + $ref: '#/components/schemas/AccountingRecordRef' + description: The account that the transfer is moving from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + amount: + type: number + format: decimal + description: The amount transferred between accounts. + type: object + AccountingTransfers: + title: 'Accounting: Transfers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingTransfer' + - $ref: '#/components/schemas/PagingInfo' + AccountsPayableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + description: Defines if the invoice or credit note is billed/rebilled to a project or customer. + enum: + - Unknown + - NotApplicable + - Customer + - Project + AccountsReceivableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + recordRef: + $ref: '#/components/schemas/AccountingRecordRef' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + enum: + - Unknown + - NotApplicable + - Project + description: Defines if the bill or bill credit note is billed/rebilled to a project. + AgedCurrencyOutstanding: + type: object + title: 'Accounting: Aged currency outstanding' + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + agedOutstandingAmounts: + type: array + description: Array of outstanding amounts by period. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmount' + definitions: + agedOutstandingAmount: + type: object + title: Aged outstanding amount + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date of period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date of period. + amount: + type: number + format: decimal + description: The amount outstanding. + details: + type: array + description: Array of details. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmountDetail' + agedOutstandingAmountDetail: + type: object + title: Amounts outstanding by data type + properties: + name: + type: string + description: Name of data type with outstanding amount for given period. + amount: + type: number + format: decimal + description: The amount outstanding. + Attachments: + x-internal: true + type: object + properties: + attachments: + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + title: Attachments + BankFeedBankAccountMapping: + title: Bank feed account mapping + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The date from which bank transactions can be provided to the platform. + required: + - sourceAccountId + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + BankFeedBankAccountMappingResponse: + title: Bank feed account mapping response + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account. + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account. + status: + type: string + nullable: true + description: Status of the POST request. + error: + type: string + nullable: true + description: Error returned during the post request + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + status: Failed + error: A feed connection already exists to this account + BankFeedMapping: + title: Bank feed mapping + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account. + sourceAccountName: + type: string + description: Name for the source account. + sourceAccountNumber: + type: string + description: Account number for the source account. + sourceBalance: + type: number + format: decimal + description: Balance for the source account. + sourceCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account in the accounting software. + targetAccountName: + type: string + description: Name for the target account in the accounting software. + status: + type: string + description: The status. + targetAccountOptions: + type: array + nullable: true + description: An array of potential target accounts. + items: + $ref: '#/components/schemas/BankFeedMapping/definitions/targetAccountOption' + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The date from which bank transactions can be provided to the platform. + description: 'A bank feed connection between a source account and a target account, including potential target accounts.' + definitions: + targetAccountOption: + title: Target Account Option + type: object + properties: + id: + type: string + description: Id of the target account. + name: + type: string + nullable: true + description: Name of the target account. + balance: + type: number + format: decimal + nullable: true + description: The balance of the account. + sortCode: + type: string + nullable: true + description: The sort code of the account. + accountNumber: + type: string + nullable: true + description: The account number of the account. + bankFeedMappings: + title: Bank feed mappings + type: array + items: + $ref: '#/components/schemas/BankFeedMapping' + additionalProperties: false + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + sourceCurrency: USD + status: Success + feedStartDate: '2023-01-09T14:14:14.1057478Z' + sourceAccountName: ACME Bank + sourceAccountNumber: 1234-5678 + sourceBalance: 500 + targetAccountName: ACME Bank + - sourceAccountId: c53fd75a-dddb-4493-839a-5090b008f625 + status: pending + targetAccountOptions: + - name: account-081 + id: 044096a7-1478-4554-8820-f478caad1b00 + balance: 100.99 + sortCode: '602336' + accountNumber: '23203' + sourceAccountName: bank name here + sourceAccountNumber: '5670' + sourceBalance: 1550 + sourceCurrency: GBP + BankingAccount: + title: 'Banking: Bank account' + description: |- + This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The ID of the account from the provider. + name: + minLength: 1 + type: string + description: The name of the account according to the provider. + informalName: + type: string + nullable: true + description: 'The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.' + holder: + type: string + nullable: true + description: The name of the person or company who holds the account. + type: + $ref: '#/components/schemas/AccountingBankAccountType' + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + description: An object containing bank balance data. + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + currency: + minLength: 1 + type: string + description: The currency code for the account. + institution: + $ref: '#/components/schemas/BankingAccount/definitions/accountInstitution' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + - type + - balance + - identifiers + - currency + - institution + definitions: + accountIdentifiers: + title: Account Identifiers + description: An object containing bank account identification information. + type: object + x-internal: true + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifierType' + subtype: + type: string + nullable: true + description: Detailed account category + number: + type: string + nullable: true + description: 'The account number for the account. When combined with the`bankCode`, this is usually enough to uniquely identify an account within a jurisdiction.' + bankCode: + type: string + nullable: true + description: |- + The local (usually national) routing number for the account. + + This is known by different names in different countries: + * BSB code (Australia) + * routing number (Canada, USA) + * sort code (UK) + iban: + type: string + nullable: true + description: 'The international bank account number (IBAN) for the account, if known.' + bic: + type: string + nullable: true + description: 'The ISO 9362 code (commonly called SWIFT code, SWIFT-BIC or BIC) for the account.' + maskedAccountNumber: + type: string + nullable: true + description: A portion of the actual account `number` to help account identification where number is tokenised (Plaid only) + required: + - type + accountIdentifierType: + type: string + x-internal: true + description: Type of account + enum: + - Account + - Card + - Credit + - Depository + - Investment + - Loan + - Other + accountInstitution: + title: Account Institution + description: The bank or other financial institution providing the account. + x-internal: true + type: object + additionalProperties: false + properties: + id: + type: string + description: 'The institution''s ID, according to the provider.' + name: + type: string + description: 'The institution''s name, according to the underlying provider.' + examples: + - results: + - id: 1703194f-7805-4da8-bac0-2ba5da4a4216 + name: Business Current Account + informalName: Codat + holder: Codat Ltd + type: Debit + balance: + available: -459987.97 + current: -459964.9 + limit: 5000 + identifiers: + type: Depository + subtype: checking + number: '46762629' + bankCode: 009911 + iban: GB29 LOYD 4773 2346 7626 29 + bic: LOYDGB21006 + maskedAccountNumber: LOYDGB21006 + currency: GBP + institution: + id: lloyds-bank + name: Lloyds Bank + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-08-14T05:04:12' + BankingAccountBalance: + title: 'Banking: Account balance' + description: "The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction.\n\nResponses are paged, so you should provide `page` and `pageSize` query parameters in your request.\n\n> **How often should I pull Account Balances?**\n>\n> Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/lending-api#/schemas/Account) data type.\n> \n> Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer." + type: object + allOf: + - type: object + properties: + accountId: + minLength: 1 + type: string + description: The unique identifier of the account. + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + date: + $ref: '#/components/schemas/DateTime' + description: Date of the balance. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - accountId + - balance + - date + definitions: + accountBalanceAmounts: + title: Account Balance Amounts + x-internal: true + type: object + properties: + available: + type: number + format: decimal + nullable: true + description: 'The balance available in the account, including any pending transactions. This doesn''t include additional funds available from any overdrafts.' + current: + type: number + format: decimal + description: The balance of the account only including cleared transactions. + limit: + type: number + format: decimal + nullable: true + description: 'The minimum allowed balance for the account. For example, a $100.00 overdraft would show as a limit of `-100.00`.' + additionalProperties: false + description: 'Depending on the data provided by the underlying bank, not all balances are always available.' + examples: + - accountBalances: + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-18T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-19T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714195.66 + current: 714204.39 + limit: 5000 + date: '2021-03-22T00:00:00' + - accountId: 2f593774-1075-4805-a552-84eecc7eb264 + balance: + available: -644945.42 + current: -644925.84 + limit: 0 + date: '2022-03-09T00:00:00' + BankingAccountBalances: + title: 'Banking: Account balances' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccountBalance' + - $ref: '#/components/schemas/PagingInfo' + BankingAccounts: + title: 'Banking: Bank accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/PagingInfo' + BankingTransaction: + title: 'Banking: Transaction' + description: |- + The Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction. + accountId: + minLength: 1 + type: string + description: The unique identifier of the bank account. + description: + type: string + nullable: true + description: The description of the bank transaction. + amount: + type: number + format: decimal + description: The amount of the bank transaction. + currency: + minLength: 1 + type: string + description: The currency of the bank transaction. + postedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was cleared. + authorizedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was authorized. + code: + $ref: '#/components/schemas/BankingTransaction/definitions/transactionCode' + merchantName: + type: string + nullable: true + description: The name of the merchant. + transactionCategoryRef: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryRef' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - accountId + - currency + definitions: + transactionCode: + type: string + x-internal: true + description: Code to identify the underlying transaction. + enum: + - Unknown + - Fee + - Payment + - Cash + - Transfer + - Interest + - Cashback + - Cheque + - DirectDebit + - Purchase + - StandingOrder + - Adjustment + - Credit + - Other + - NotSupported + examples: + - id: 0130b5bb-1419-40f6-8a27-7362d0381229 + accountId: 1703194f-7805-4da8-bac0-2ba5da4a4216 + description: Payments for direct income ce149943-c157-43fc-aac7-42a716b655b6 + amount: 5062.39 + currency: GBP + postedDate: '2021-07-06T00:00:00' + authorizedDate: '2021-07-06T00:00:00' + merchantName: New Look + transactionCategoryRef: + id: health-and-fitness-sports + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-06-28T10:48:12' + BankingTransactionCategories: + title: 'Banking: Transaction categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransactionCategory' + - $ref: '#/components/schemas/PagingInfo' + BankingTransactionCategory: + title: 'Banking: Transaction category' + description: |- + The Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + description: Status of the bank transaction category. + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction category. + name: + minLength: 1 + type: string + description: The name of the bank transaction category. + parentId: + type: string + nullable: true + description: The unique identifier of the parent bank transaction category. + hasChildren: + type: boolean + description: A Boolean indicating whether there are other bank transaction categories beneath this one in the hierarchy. + status: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + definitions: + transactionCategoryRef: + type: object + x-internal: true + description: An object of bank transaction category reference data. + properties: + id: + minLength: 1 + type: string + description: The unique category reference id for the bank transaction. + name: + type: string + nullable: true + description: The category name reference for the bank transaction. + required: + - id + transactionCategoryStatus: + type: string + description: The status of the transaction category. + x-internal: true + enum: + - Unknown + - Active + - Archived + examples: + - id: auto-and-transport + name: Auto & Transport + hasChildren: true + status: Active + modifiedDate: '2022-05-23T16:32:50' + sourceModifiedDate: '2021-04-24T07:59:10' + BankingTransactions: + title: 'Banking: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransaction' + - $ref: '#/components/schemas/PagingInfo' + BankStatementUploadConfiguration: + title: Banking data upload settings + description: Configuration settings for uploading banking data to Codat + additionalProperties: false + type: object + properties: + source: + type: string + enum: + - codat + description: The source of the banking data that determines its format + accountId: + type: string + description: The ID of the account in the third-party platform + providerId: + type: string + description: TrueLayer provider ID (only required if source is TrueLayer) + CategorizedBankStatementAccounts: + title: Categorized bank statement accounts + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow accounts endpoint provides a list of accounts that categorized transactions have been taken from. + allOf: + - type: object + properties: + results: + type: array + items: + title: Account + type: object + properties: + id: + description: The ID of the account from the provider. + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=2&pageSize=10 + CategorizedBankStatementTransactions: + title: Categorized bank statement transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: null + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + ClientRateLimitWebhook: + title: Client rate limit webhook + type: object + properties: + id: + type: string + format: uuid + example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - client.rateLimit.reset + - client.rateLimit.reached + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' + definitions: + clientRateLimitWebhookPayload: + title: Client rate limit webhook payload + type: object + properties: + dailyQuota: + type: integer + description: The number of available requests per day. + quotaRemaining: + type: integer + description: Total number of requests remaining for your client. + expiryDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC when your daily quota is reset. + CommerceAddress: + title: 'Commerce: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/CommerceAddress/definitions/commerceAddressType' + line1: + description: The first line of the address + type: string + line2: + description: The second line of the address + type: string + city: + description: 'The third line of the address, or city' + type: string + region: + description: 'The fourth line of the address, or region' + type: string + country: + description: The country for the address + type: string + postalCode: + description: The postal (or zip) code for the address + type: string + definitions: + commerceAddressType: + description: The type of the address + type: string + enum: + - Billing + - Delivery + - Order + - Inventory + - Unknown + CommerceCompanyInfo: + title: 'Commerce: Company profile' + description: "In the Codat system, company profile includes standard commercial details about \na linked company, such as their address, phone number, and company registration.\n" + type: object + allOf: + - type: object + properties: + companyName: + type: string + description: The name of the company + example: Codat + commercePlatformRef: + type: string + description: Identifier or reference for the company in the commerce software + companyLegalName: + type: string + description: The full legal name of the company + example: Codat Limited + addresses: + type: array + description: Addresses associated with the company + items: + $ref: '#/components/schemas/CommerceAddress' + phoneNumbers: + type: array + description: Phone numbers associated with the company + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + description: Weblinks associated with the company + type: array + items: + $ref: '#/components/schemas/WebLink' + registrationNumber: + description: The registration number of the company + type: string + examples: + - 10480375 + baseCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + accountBalances: + description: The available and current cash balances for the company's accounts + type: array + items: + $ref: '#/components/schemas/CommerceCompanyInfo/definitions/accountBalance' + sourceUrls: + description: 'URL addresses for the originating system. For example, potential use cases include ''deeplinking'' to the originating system' + type: object + additionalProperties: + type: string + example: + url1: 'https://connect.sandbox.com/v2/customers' + url2: 'https://connect.sandbox.com/v2/disputes' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountBalance: + title: Account Balance + type: object + x-internal: true + properties: + available: + description: The account's current balance + type: number + format: decimal + pending: + description: Funds that are not yet available in the balance + type: number + format: decimal + reserved: + description: Funds reserved as holdings + format: decimal + currency: + description: The currency of the account + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + CommerceCustomer: + title: 'Commerce: Customer' + description: 'When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + customerName: + type: string + description: Name of the customer + example: Fred Smith + emailAddress: + type: string + description: Email address of the customer + example: fred.smith@myCompany.com + phone: + $ref: '#/components/schemas/PhoneNumber/properties/number' + defaultCurrency: + allOf: + - description: "Default currency of any transactional data for the customer, \nfor example, orders or payments\n" + - $ref: '#/components/schemas/SourceAccount/properties/currency' + addresses: + type: array + description: Addresses of the customer + items: + $ref: '#/components/schemas/CommerceAddress' + note: + type: string + description: Any additional information about the customer + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + commerceCustomerRef: + type: object + description: Reference to the customer that placed the order. + properties: + id: + description: The unique identitifer of the customer being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the customer being referenced. + type: string + required: + - id + examples: + - customers: + - id: '15' + customerName: Daffy Duck + emailAddress: d.duck@warnerbros.com + defaultCurrency: GBP + phone: (877) 492-8687 + addresses: + - type: billing + line1: 301 Duck Pond + line2: 28 Green Street + city: London + region: England + country: United Kingdom + postalCode: WX1X 0BE + - type: delivery + line1: Bread Street + line2: Bird Avenue + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-09-15T23:52:28' + - id: '18' + customerName: Tasmanian Devil + emailAddress: t.devil@warnerbros.com + defaultCurrency: GBP + phone: +1-202-555-0181 + addresses: + - type: billing + line1: 101 Fire Rooms + line2: Engine Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + note: Handle with care + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-04-16T02:41:52' + - id: a99f5e0c-a4db-452f-8d2c-8fd15482b384 + customerName: Bugs Bunny + emailAddress: b.bunny@warnerbros.com + defaultCurrency: GBP + phone: '' + addresses: + - type: billing + line1: 301 Carrot Street + line2: Orange Town + city: Yorkshire + region: England + country: United Kingdom + postalCode: WF1X 0BE + - type: delivery + line1: 424 Field Street + line2: The Meadow + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceCustomers: + title: 'Commerce: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceCustomer' + - $ref: '#/components/schemas/PagingInfo' + CommerceDispute: + title: 'Commerce: Dispute' + description: "A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example: \n- They didn't receive an order. \n- The product they received was different to the commerce store's description. \n- They've been the victim of online fraud. \n\nYou can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks." + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + required: + - currency + properties: + disputedTransactions: + description: Link to the source event(s) which triggered this transaction. + type: array + items: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + totalAmount: + description: Total transaction amount that is under dispute. + format: decimal + examples: + - 194.12 + - -283.56 + - 0 + currency: + description: Currency of the disputed transaction. + $ref: '#/components/schemas/SourceAccount/properties/currency' + status: + $ref: '#/components/schemas/CommerceDispute/definitions/disputeStatus' + reason: + description: Reason for the dispute + type: string + examples: + - Unhappy with product + dueDate: + description: Date when the next action in the dispute resolution is due + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + disputeStatus: + description: Current status of the dispute + x-internal: true + type: string + enum: + - Won + - Lost + - Accepted + - Processing + - ChargeRefunded + - EvidenceRequired + - InquiryEvidenceRequired + - InquiryProcessing + - InquiryClosed + - WaitingThirdParty + - Unknown + example: EvidenceRequired + examples: + - id: 03e608e3-bd1c-454f-8c2b-fb0133e43b95 + disputedTransactions: + - id: e63ad857-7e12-4e64-9185-cdfd7c45d09d + type: Order + totalAmount: -47.66 + currency: GBP + status: InquiryEvidenceRequired + reason: Unhappy with product + dueDate: '2021-03-29T14:39:55' + createdDate: '2021-03-22T14:39:55' + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-22T14:39:55' + CommerceDisputes: + title: 'Commerce: Disputes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceDispute' + - $ref: '#/components/schemas/PagingInfo' + CommerceLocation: + title: 'Commerce: Location' + type: object + description: |- + The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. + + A Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + description: Name of this location + type: string + address: + description: Address associated with the location + $ref: '#/components/schemas/CommerceAddress' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + locationRef: + type: object + description: Reference to the geographic location where the order was placed. + properties: + id: + description: The unique identitifer of the location being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the location being referenced. + type: string + required: + - id + examples: + - id: '15' + name: London Warehouse + address: + type: Inventory + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalCode: WC1X 8WB + modifiedDate: '2020-08-12T14:37:37' + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceLocations: + title: 'Commerce: Locations' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceLocation' + - $ref: '#/components/schemas/PagingInfo' + CommerceOrder: + title: 'Commerce: Order' + description: | + Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). + allOf: + - type: object + x-stoplight: + id: 516bf0ecc4907 + required: + - id + properties: + id: + type: string + description: 'A unique, persistent identifier for this record' + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + x-codat-validation: + - validator: UniqueWithinConnection + - properties: + orderNumber: + type: string + description: Friendly reference for the order in the commerce or point of sale platform. + country: + description: "The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.\n\nDepending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model. \n\nFor POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint." + type: string + format: ISO3166 Alpha-3 + examples: + - GBR + - USA + - ABW + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: Currency in which the order was placed. + closedDate: + $ref: '#/components/schemas/DateTime' + description: 'Date on which order was closed after the product was shipped, paid for, and any refund period had elapsed.' + totalAmount: + description: 'Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.' + type: number + format: decimal + totalRefund: + description: 'Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.' + type: number + format: decimal + totalTaxAmount: + description: Total amount of tax applied to the order. + type: number + format: decimal + totalDiscount: + description: 'Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).' + type: number + format: decimal + totalGratuity: + description: Extra amount added to the order. + type: number + format: decimal + orderLineItems: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderLineItem' + payments: + type: array + items: + $ref: '#/components/schemas/CommercePayment/definitions/paymentRef' + serviceCharges: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceCharge' + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + customerRef: + $ref: '#/components/schemas/CommerceCustomer/definitions/commerceCustomerRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - title: Created date + type: object + x-internal: true + properties: + createdDate: + $ref: '#/components/schemas/DateTime' + description: The date the entity was created. + - title: Modified dates + x-internal: true + allOf: + - title: ModifiedDate + x-internal: true + type: object + properties: + modifiedDate: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: |- + The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. + + Use it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today. + + This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)). + + In Codat's data model, dates and times are represented using the ISO 8601 standard. + - title: Source Modified Date + x-internal: true + type: object + nullable: true + properties: + sourceModifiedDate: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: "The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The accounting software does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." + definitions: + orderLineItem: + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + quantity: + type: number + format: decimal + description: | + Number of units of the product sold. + For refunds, quantity is negative. + taxPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of any sales tax applied to the unit price. + examples: + - 0 + - 12.5 + - '45.00' + totalAmount: + type: number + format: decimal + description: 'Total amount of the line item, including discounts and tax.' + totalTaxAmount: + type: number + format: decimal + description: 'Total amount of tax applied to the line item, factoring in any discounts.' + unitPrice: + type: number + format: decimal + description: 'Price per unit of goods or services, excluding discounts and tax.' + taxes: + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + description: Taxes breakdown as applied to order lines. + productRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productRef' + productVariantRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantRef' + discountAllocations: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderDiscountAllocation' + serviceCharge: + type: object + properties: + description: + description: Service charges for this order. + type: string + example: A service charge + totalAmount: + description: 'Total amount of the service charge, including tax.' + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxPercentage: + description: Percentage rate (from 0 to 100) of any tax applied to the service charge. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxAmount: + description: Amount of the service charge that is tax. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxes: + description: Taxes breakdown as applied to service charges. + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + quantity: + description: The number of times the charge is charged. + type: integer + examples: + - 1 + - 12 + - 45 + type: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceChargeType' + serviceChargeType: + description: The type of the service charge. + type: string + enum: + - Generic + - Shipping + - Overpayment + - Unknown + example: Overpayment + orderDiscountAllocation: + type: object + properties: + name: + type: string + description: Name of the discount in the commerce or point of sale platform. + example: Promotional Discount + totalAmount: + type: number + format: decimal + description: 'Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).' + example: 15.25 + examples: + - id: 01e63721-1205-478e-8503-9d8bf8a93f44 + orderNumber: '99123956' + country: CAN + currency: CAD + createdDate: '2021-03-28T03:00:14' + totalAmount: 12 + totalRefund: 0 + totalTaxAmount: 2 + totalDiscount: 0 + totalGratuity: 1 + orderLineItems: + - id: 116113a6-54d3-4624-ba73-26a77a5ffd51 + quantity: 1 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 10 + taxes: + - taxComponentRef: + id: '72' + name: Sales Tax + taxAmount: '' + - taxComponentRef: + id: '72' + name: City Tax + taxAmount: '' + productRef: + id: ac186646-41f2-4280-afea-1012c59459ab + name: Intelligent Concrete Salad + productVariantRef: + id: f9ca9de5-9e31-460d-ac81-368f4e7c8fc0 + name: Small Incredible Wooden Soap + discountAllocations: [] + payments: + - id: defdceb6-83a3-4b7d-a74e-e9ef947d5f48 + amount: 12 + currency: CAD + type: Paypal + status: Unknown + dueDate: '2021-04-04T03:00:14' + createdDate: '2021-03-28T03:00:14' + modifiedDate: '2022-02-02T11:02:45' + serviceCharges: + - description: Service Charge + totalAmount: 1.2 + taxPercentage: 20 + taxAmount: 0.2 + taxes: + - taxComponentRef: + id: '72' + name: Service Tax + taxAmount: '' + quantity: 1 + type: Generic + locationRef: + id: 47bbffc7-c045-4b0f-a3bb-ecf1f669edfa + customerRef: + id: 2634d180-7205-43f0-a73d-84af6443a005 + name: Emmy Roberts + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-28T03:00:14' + type: object + CommerceOrders: + title: 'Commerce: Orders' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceOrder' + - $ref: '#/components/schemas/PagingInfo' + CommercePayment: + title: 'Commerce: Payment' + description: |- + Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status. + + Refunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`. + + You can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR). + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + description: Payment Amount (including gratuity) + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentStatus: + type: string + x-internal: true + description: Status of the payment. + enum: + - Pending + - Authorized + - Paid + - Failed + - Cancelled + - Unknown + paymentType: + type: string + x-internal: true + nullable: true + description: Type of payment. + enum: + - Cash + - Card + - Invoice + - OnlineCard + - Swish + - Vipps + - Mobile + - StoreCredit + - Paypal + - Custom + - Prepaid + - Unknown + example: Cash + paymentRef: + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + nullable: true + description: Payment Amount (including gratuity). + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made. + type: + $ref: '#/components/schemas/CommercePayment/definitions/paymentType' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethod: + title: 'Commerce: Payment method' + description: A Payment Method represents the payment method(s) used to make payments. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the PaymentMethod + example: Alipay + status: + description: Status of the Payment Method. + x-internal: true + type: string + enum: + - Unknown + - Active + - Archived + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethods: + title: 'Commerce: Payment methods' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePaymentMethod' + - $ref: '#/components/schemas/PagingInfo' + CommercePayments: + title: 'Commerce: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePayment' + - $ref: '#/components/schemas/PagingInfo' + CommerceProduct: + title: 'Commerce: Product' + description: | + A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the product in the commerce or POS system + examples: + - Hard Drive + - Windows Installation + - Software Support (Hourly) + description: + type: string + description: Description of the product recorded in the commerce or point of sale platform. + examples: + - 1tb Western Digital Hard Drive + - Install of Windows 11 (Professional Edition) + - 1 hour of support from an agent (phone or remote) + categorization: + type: string + description: Retail category that the product is assigned to e.g. `Hardware`. + examples: + - Hardware + - Software + - Support Services + isGiftCard: + type: boolean + description: | + Whether the product represents a gift card or voucher that + can be redeemed in the commerce or POS platform. + variants: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariant' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + definitions: + productRef: + type: object + description: Reference that links the line item to the correct product details. + properties: + id: + description: The unique identifier of the product being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product being referenced. + type: string + required: + - id + productVariant: + title: Product Variant + description: | + Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + description: 'Identifier of the product variant, unique to the company.' + - properties: + name: + type: string + examples: + - Red Coat + - Black Coat + - Large Brown Hat + description: Name of the product recorded in the commerce or point of sale platform. + isTaxEnabled: + type: boolean + description: Whether sales taxes are enabled for this product variant. + sku: + type: string + examples: + - Coat-Red-Lrg + - Coat-Black-Md + - LargeBrownHat + - A725BA2 + description: 'SKU (stock keeping unit) of the variant, as defined by the merchant.' + barcode: + type: string + examples: + - '564158468416486458646886484' + - CSE370 + description: 'Unique product number of the variant. This might be a barcode, UPC, ISBN, etc.' + unitOfMeasure: + type: string + examples: + - kg + - m + - meters + description: 'Unit of measure for the variant, such as `kg` or `meters`.' + vatPercentage: + type: number + format: decimal + examples: + - 12.5 + - 0 + - 20 + description: VAT rate for the product variant if sales taxes are enabled. + prices: + type: array + description: Prices for the product variants in different currencies. + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productPrice' + inventory: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventory' + shippingRequired: + type: boolean + description: Indicates whether or not the product requires physical delivery. + status: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + productVariantRef: + title: Product variant reference + type: object + description: Reference that links the line item to the specific version of product that has been ordered. + properties: + id: + description: The unique identifier of the product variant being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product variant being referenced. + type: string + required: + - id + productPrice: + title: Product Price Variant + x-internal: true + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + nullable: true + unitPrice: + type: number + format: decimal + description: The product variant's unit price. + productInventory: + title: Product Inventory + description: Information about the total inventory as well as the locations inventory is in. + x-internal: true + type: object + properties: + totalQuantity: + type: number + format: decimal + nullable: true + description: The total quantity of stock remaining across locations. + locations: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventoryLocation' + productInventoryLocation: + title: Product Inventory Location + x-internal: true + type: object + properties: + quantity: + type: number + format: decimal + description: The quantity of stock remaining at location. + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + productVariantStatus: + x-internal: true + type: string + description: The status of the product variant. + enum: + - Unknown + - Published + - Unpublished + CommerceProductCategories: + title: 'Commerce: Product categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProductCategory' + - $ref: '#/components/schemas/PagingInfo' + CommerceProductCategory: + title: 'Commerce: Product category' + description: 'Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.' + type: object + allOf: + - type: object + properties: + id: + type: string + example: '"102"' + description: The unique identifier of the product category + name: + type: string + example: Entertainment + description: The name of the product category + ancestorRefs: + type: array + description: A collection of parent product categories implicitly ordered with the immediate parent last in the list. + items: + $ref: '#/components/schemas/CommerceRecordRef' + hasChildren: + type: boolean + description: A boolean indicating whether there are other product categories beneath this one in the hierarchy. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: + - productCategories: + - id: '100' + name: Entertainment + ancestorRefs: [] + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:53:21Z' + - id: '101' + name: Cinema + ancestorRefs: + - id: '100' + name: Entertainment + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:55:02Z' + - id: '102' + name: Movie + ancestorRefs: + - id: '100' + name: Entertainment + - id: '101' + name: Cinema + hasChildren: false + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-12-25T12:00:00Z' + CommerceProducts: + title: 'Commerce: Products' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProduct' + - $ref: '#/components/schemas/PagingInfo' + CommerceRecordRef: + title: Record Ref + x-internal: true + type: object + properties: + id: + description: The unique identitifer of the record being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + type: + description: The type of record being referenced. + type: string + required: + - id + - type + description: '' + CommerceReport: + title: Commerce report + description: "## Structure\n\nAssess reports follow a consistent structure. Reports contain four sections of information:\n\n### 1. Report definition\n\nInformation such as:\n\n 1. The report info (e.g. enhanced_profit_and_loss).\n 2. The display name of the report (e.g. Enhanced Profit and Loss).\n \n### 2. Dimension info\n\nInformation about the dimension contained in the reports such as:\n\n 1. The type of dimension (e.g. datetime, recordRef).\n 2. The display name of the dimension (e.g. Period, Category type, Category sub type).\n 3. The details about each item within the dimension (e.g. displayName:\"Jan 2022\", start:\"...\", end:\"...\", id:\"...\", name:\"...\").\n\n### 3. Measure info\n\nInformation about the measures contained in the report such as:\n\n 1. The display name of the measure (e.g. value of account, percentage change).\n 2. The type of the measure (e.g. currency, percentage).\n 3. The unit of the measure (e.g. %, GBP).\n \n### 4. The data for the report\n\nWhen the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*.\n\n\n## Displaying the report\n\nReports can be rendered as follows (ordering is implicit rather than explicit):\n\n![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png)\n\n# Data model\n\n## Dimensions" + type: object + properties: + reportInfo: + type: object + additionalProperties: + type: string + dimensions: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportDimension' + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportMeasure' + reportData: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + errors: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportError' + definitions: + commerceReportMeasure: + title: Measure + type: object + properties: + displayName: + description: The measure's display name. + type: string + units: + type: string + description: The measure's units e.g. percentage (%). + index: + type: integer + description: The measure's index. + type: + type: string + description: The measure's type. + commerceReportError: + title: Error + type: object + properties: + message: + type: string + description: Message returned by error. + type: + type: string + description: The type of error. + details: + description: Additional details on the error. + type: object + additionalProperties: + type: array + items: + type: string + commerceReportDimension: + title: Dimension + type: object + properties: + index: + type: integer + description: The dimension's index. + displayName: + type: string + description: The dimension's display name. + type: + type: string + description: The dimension's type. + items: + type: array + items: + type: object + properties: + index: + type: integer + description: The dimension's items index. + commerceReportComponent: + title: Report component + type: object + properties: + dimension: + type: integer + description: The component's dimension. + dimensionDisplayName: + type: string + description: The component's display name. + item: + type: integer + description: The component's item number. + itemDisplayName: + type: string + description: The component's item display name. + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/reportComponentMeasure' + components: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + reportComponentMeasure: + type: object + title: Report component measure + properties: + index: + type: integer + description: The measure's index. + measureDisplayName: + type: string + description: The measure's display name. + value: + type: number + format: decimal + description: The measure's value. + x-examples: + Example 1: + reportInfo: + additionalProp1: string + additionalProp2: string + additionalProp3: string + dimensions: + - index: 0 + displayName: string + type: string + items: + - index: 0 + measures: + - displayName: string + units: string + index: 0 + type: string + reportData: + - dimension: 0 + dimensionDisplayName: string + item: 0 + itemDisplayName: string + measures: + - index: 0 + measureDisplayName: string + components: + - string + errors: + - message: string + type: DatesOutOfRange + details: + additionalProp1: + - string + additionalProp2: + - string + additionalProp3: + - string + CommerceTaxComponent: + title: 'Commerce: Tax component' + description: 'The Tax Components endpoints return tax rates data from the commerce software, including tax rate names and values. This is to support the mapping of tax rates from the commerce software to those in the accounting software.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the Tax Rate Component in the source commerce software. + example: Sales Tax + rate: + description: Rate of taxation represented as a fraction of the net price (typically in the range 0.00 - 1.00). + type: number + format: decimal + examples: + - 0.15 + - 0.2 + isCompound: + description: The Boolean flag to indicate when a Tax Rate Component compounds on a sale. + type: boolean + examples: + - true + - false + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - name + definitions: + taxComponentAllocation: + title: Tax Component Allocation + type: object + properties: + taxComponentRef: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentRef' + rate: + description: Tax amount on order line sale as available from source commerce software. + type: number + format: decimal + nullable: true + taxComponentRef: + type: object + description: Taxes rates reference object depending on the rates being available on source commerce software. + properties: + id: + description: The unique identitifer of the tax component being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the tax component being referenced. + type: string + required: + - id + - name + examples: + - id: 13d946f0-c5d5-42bc-b092-97ece17923ab + name: Sales Tax (15%) + rate: 0.15 + isCompound: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + CommerceTransaction: + title: 'Commerce: Transaction' + description: "Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees.\n\nYou can use data from the Transactions endpoints to calculate key metrics, such as: \n- Transaction volumes \n- Average transaction volume \n- Average transaction value \n- Returns \n- Payouts" + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + totalAmount: + description: The total transaction amount + type: number + format: decimal + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionType' + subType: + description: Non-standardised transaction type data from the commerce software + type: string + examples: + - CardPayment + - Invoice payment + transactionSourceRef: + description: Link to the source event which triggered this transaction + allOf: + - $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - allOf: + - type: object + x-stoplight: + id: c590b4405180f + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - type: object + x-stoplight: + id: gdyjg7bg783br + properties: + sourceCreatedDate: + $ref: '#/components/schemas/DateTime' + description: The date on which this record was created in the originating system + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + x-stoplight: + id: 9e815c1766554 + definitions: + transactionSourceRef: + title: Transaction Source Reference + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceRecordRef' + - type: object + properties: + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceType' + transactionSourceType: + x-internal: true + type: string + description: The type of source the transaction arose. + enum: + - Fee + - Order + - Payment + - ServiceCharge + - Unknown + transactionType: + x-internal: true + description: "The type of the platform transaction: \n- `Unknown` \n- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account. \n- `Payment` — Credit and debit card payments. \n- `PaymentFee` — Payment provider's fee on each card payment. \n- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller. \n- `Payout` — Transfer of funds from the seller's merchant account to their bank account. \n- `Refund` — Refunds to a customer's credit or debit card. \n- `Transfer` — Secure transfer of funds to the seller's bank account. " + type: string + enum: + - Payment + - Refund + - Payout + - FailedPayout + - Transfer + - PaymentFee + - PaymentFeeRefund + - Unknown + examples: [] + CommerceTransactions: + title: 'Commerce: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceTransaction' + - $ref: '#/components/schemas/PagingInfo' + Companies: + title: Companies + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Company' + - $ref: '#/components/schemas/PagingInfo' + Company: + title: Company + description: "\uFEFF\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\x20\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x58\x65\x72\x6F\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2F\x78\x65\x72\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x78\x65\x72\x6F\x29\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x5B\x50\x6C\x61\x69\x64\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2F\x70\x6C\x61\x69\x64\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x70\x6C\x61\x69\x64\x29\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x5A\x65\x74\x74\x6C\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2F\x7A\x65\x74\x74\x6C\x65\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x7A\x65\x74\x74\x6C\x65\x29\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x54\x79\x70\x69\x63\x61\x6C\x6C\x79\x20\x65\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x69\x73\x20\x6F\x6E\x65\x20\x6F\x66\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x73\x2E\n\n\x57\x68\x65\x6E\x20\x79\x6F\x75\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x73\x70\x65\x63\x69\x66\x79\x20\x61\x20\x60\x6E\x61\x6D\x65\x60\x20\x61\x6E\x64\x20\x77\x65\x20\x77\x69\x6C\x6C\x20\x61\x75\x74\x6F\x6D\x61\x74\x69\x63\x61\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x20\x61\x20\x75\x6E\x69\x71\x75\x65\x20\x60\x69\x64\x60\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x61\x6C\x73\x6F\x20\x61\x64\x64\x20\x61\x20\x60\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x60\x20\x74\x6F\x20\x73\x74\x6F\x72\x65\x20\x61\x6E\x79\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" + type: object + allOf: + - $ref: '#/components/schemas/Company/definitions/companyDetails' + - type: object + properties: + dataConnections: + type: array + items: + $ref: '#/components/schemas/Connection' + definitions: + companyDetails: + title: Company details + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + type: string + description: The name of the company + example: Codat Ltd. + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + nullable: true + redirect: + type: string + format: uri + description: '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.' + example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + createdByUserName: + type: string + description: Name of user that created the company in Codat. + nullable: true + products: + type: array + items: + type: string + description: An array of products that are currently enabled for the company. + tags: + title: Tags + type: object + maxProperties: 10 + propertyNames: + pattern: '^.{1,27}$' + additionalProperties: + type: string + maxLength: 100 + description: A collection of user-defined key-value pairs that store custom metadata against the company. + referenceParentCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + nullable: true + description: The parent entity or controlling organization of this company. Null if the company has no parent. + referenceSubsidiaryCompanies: + type: array + nullable: false + description: A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + minItems: 0 + items: + $ref: '#/components/schemas/Company/definitions/companyReference' + required: + - id + - name + - redirect + companyReference: + title: Company reference + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' + description: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' + links: + type: object + description: A collection of links for the company. + properties: + portal: + type: string + format: uri + description: Link to the company page in the portal. + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + examples: + - 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 + products: + - spend-insights + - lending + CompanyRequestBody: + title: Create company request + x-internal: true + type: object + properties: + name: + type: string + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + type: string + example: Requested early access to the new financing scheme. + description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + required: + - name + CompanyUpdateRequest: + title: Update company request + x-internal: true + type: object + properties: + name: + type: string + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + Connection: + title: Connection + description: "\uFEFF\x41\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x61\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x6E\x64\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x73\x79\x6E\x63\x68\x72\x6F\x6E\x69\x7A\x65\x20\x64\x61\x74\x61\x20\x28\x70\x75\x6C\x6C\x20\x61\x6E\x64\x2F\x6F\x72\x20\x70\x75\x73\x68\x29\x20\x77\x69\x74\x68\x20\x74\x68\x61\x74\x20\x73\x6F\x75\x72\x63\x65\x2E\n\n\x41\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x69\x74\x20\x69\x73\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6E\x67\x20\x74\x6F\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x6C\x69\x6E\x6B\x20\x74\x6F\x3A\n\n\x2D\x20\x5B\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x31\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2E\n\x2D\x20\x5B\x42\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x2D\x20\x5B\x43\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x41\x6E\x79\x20\x63\x6F\x6D\x62\x69\x6E\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2C\x20\x62\x61\x6E\x6B\x69\x6E\x67\x2C\x20\x61\x6E\x64\x20\x63\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x69\x73\x20\x61\x6C\x6C\x6F\x77\x65\x64\x2E\n\n\x42\x65\x66\x6F\x72\x65\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x61\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x70\x75\x6C\x6C\x20\x6F\x72\x20\x70\x75\x73\x68\x20\x64\x61\x74\x61\x2C\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x6D\x75\x73\x74\x20\x67\x72\x61\x6E\x74\x20\x79\x6F\x75\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x64\x61\x74\x61\x20\x62\x79\x20\x5B\x6C\x69\x6E\x6B\x69\x6E\x67\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x75\x74\x68\x2D\x66\x6C\x6F\x77\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E" + type: object + properties: + id: + $ref: '#/components/parameters/connectionId/schema' + integrationId: + type: string + format: uuid + example: fd321cb6-7963-4506-b873-e99593a45e30 + description: A Codat ID representing the integration. + integrationKey: + type: string + description: 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. + sourceId: + type: string + format: uuid + example: 35b92968-9851-4095-ad60-395c95cbcba4 + description: '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`.' + sourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + platformName: + type: string + description: Name of integration connected to company. + linkUrl: + type: string + format: uri + description: The link URL your customers can use to authorize access to their business application. + example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' + status: + $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + dataConnectionErrors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Connection/definitions/dataConnectionError' + connectionInfo: + type: object + nullable: true + additionalProperties: true + additionalProperties: false + required: + - id + - integrationId + - integrationKey + - sourceId + - platformName + - linkUrl + - status + - created + - sourceType + definitions: + dataConnectionStatus: + title: Data connection status + description: The current authorization status of the data connection. + type: string + enum: + - PendingAuth + - Linked + - Unlinked + - Deauthorized + dataConnectionError: + title: Data connection error + type: object + properties: + statusCode: + type: string + description: The HTTP status code returned by the source platform when the error occurred. + statusText: + type: string + description: A non-numeric status code/text returned by the source platform when the error occurred. + errorMessage: + type: string + description: A message about a error returned by Codat. + erroredOnUtc: + $ref: '#/components/schemas/DateTime' + status: + title: Error status + description: The current status of a transient error. Null statuses indicate that the error is not transient. + type: string + nullable: true + enum: + - Active + - Resolved + resolvedOnUtc: + description: The datetime in Utc that the error was resolved. + nullable: true + $ref: '#/components/schemas/DateTime' + dataConnectionSourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + example: + 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 + Connections: + title: Connections + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Connection' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityDetail: + title: Data integrity detail + type: object + properties: + id: + type: string + description: ID GUID of the transaction. + type: + type: string + description: The data type of the record. + connectionId: + type: string + format: uuid + description: ID GUID representing the connection of the accounting or banking platform. + readOnly: true + date: + $ref: '#/components/schemas/DateTime' + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: number + format: decimal + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + matches: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail/definitions/dataIntegrityMatch' + definitions: + dataIntegrityMatch: + type: object + properties: + id: + type: string + description: ID GUID of the transaction. + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + connectionId: + type: string + description: ID GUID representing the connection of the accounting or banking platform. + format: uuid + date: + type: string + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: string + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + DataIntegrityDetails: + title: Data integrity details + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityStatus: + title: Data integrity status + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + statusInfo: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityStatusInfo' + connectionIds: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityConnectionId' + amounts: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityAmounts' + dates: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityDates' + definitions: + dataIntegrityStatusInfo: + type: object + properties: + lastMatched: + type: string + $ref: '#/components/schemas/DateTime' + description: The date the matching algorithm last ran against the company’s data type specified. + readOnly: true + currentStatus: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/integrityStatus' + statusMessage: + type: string + description: Detailed explanation supporting the status value. + dataIntegrityConnectionId: + type: object + properties: + source: + type: array + description: An array of strings. The connection IDs for the type specified in the url. + items: + type: string + target: + type: array + description: An array of strings. The connection IDs for the type being matched to. + items: + type: string + dataIntegrityAmounts: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + min: + type: number + format: decimal + description: Lowest value of transaction set. + max: + type: number + format: decimal + description: Highest value of transaction set. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityDates: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + minDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date of transaction set. + readOnly: true + maxDate: + $ref: '#/components/schemas/DateTime' + description: Latest date of transaction set. + readOnly: true + minOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date where transactions exist in both accounting and banking platforms. + readOnly: true + maxOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Latest date where transactions exist in both account and banking platforms. + readOnly: true + integrityStatus: + type: string + enum: + - Unknown + - DoesNotExist + - Error + - Complete + description: The current status of the most recently run matching algorithm. + examples: + - type: string + statusInfo: + lastMatched: '2021-10-24T14:15:22Z' + currentStatus: Unknown + statusMessage: string + connectionIds: + source: + - d5a8d1b2-b38a-4e44-8641-548ad43be6bb + - da8c9f39-8af9-4a98-964b-f1e207942837 + target: + - 3d7ce25a-c107-44bc-8e0c-36c10bdd14e0 + - a5300eac-01fa-4a77-b5b0-ea0b86a3be69 + amounts: + min: 130 + max: 2450 + currency: GBP + dates: + minDate: '2021-09-17T12:09:33.441Z' + maxDate: '2021-12-16T12:12:53.441Z' + minOverlappingDate: '2021-09-30T12:09:13.441Z' + maxOverlappingDate: '2021-11-27T12:19:33.441Z' + DataIntegrityStatuses: + title: Data integrity statuses + x-internal: true + type: object + properties: + metadata: + type: array + items: + $ref: '#/components/schemas/DataIntegrityStatus' + DataIntegritySummaries: + title: Data integrity summaries + x-internal: true + type: object + properties: + summaries: + type: array + items: + $ref: '#/components/schemas/DataIntegritySummary' + DataIntegritySummary: + title: Data integrity summary + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + byAmount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByAmount' + byCount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByCount' + definitions: + dataIntegrityType: + type: object + properties: + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + dataIntegrityByAmount: + title: Data integrity by amount + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of the absolute value of transactions of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityByCount: + title: Data integrity by count + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of records of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The number of records of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The number of records of the type specified in the route which do have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + DataStatus: + title: Data status + description: Describes the state of data in the Codat cache for a company and data type + type: object + required: + - dataType + - currentStatus + properties: + dataType: + title: Data types + x-internal: true + type: string + description: Available data types + enum: + - accountTransactions + - balanceSheet + - bankAccounts + - bankTransactions + - billCreditNotes + - billPayments + - bills + - cashFlowStatement + - chartOfAccounts + - company + - creditNotes + - customers + - directCosts + - directIncomes + - invoices + - itemReceipts + - items + - journalEntries + - journals + - paymentMethods + - payments + - profitAndLoss + - purchaseOrders + - salesOrders + - suppliers + - taxRates + - trackingCategories + - transfers + - banking-accountBalances + - banking-accounts + - banking-transactionCategories + - banking-transactions + - commerce-companyInfo + - commerce-customers + - commerce-disputes + - commerce-locations + - commerce-orders + - commerce-paymentMethods + - commerce-payments + - commerce-productCategories + - commerce-products + - commerce-taxComponents + - commerce-transactions + example: invoices + lastSuccessfulSync: + $ref: '#/components/schemas/DateTime' + currentStatus: + $ref: '#/components/schemas/PullOperation/properties/status' + latestSyncId: + type: string + description: Unique identifier for most recent sync of data type. + format: uuid + example: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: + type: string + description: Unique identifier for the most recent successful sync of data type. + format: uuid + example: 8220fc90-55b6-47bc-9417-48ac6ea93101 + examples: + - dataType: string + lastSuccessfulSync: '2022-01-01T13:00:00.000Z' + currentStatus: string + latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 + DataStatusResponse: + x-internal: true + title: Data status response + type: object + additionalProperties: + $ref: '#/components/schemas/DataStatus' + DataType: + x-internal: true + $ref: '#/components/schemas/DataStatus/properties/dataType' + DateTime: + title: Date time + type: string + examples: + - '2022-10-23T00:00:00Z' + - '2022-10-23' + description: "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:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." + EndUploadSessionRequest: + title: End upload session request + type: object + properties: + status: + type: string + enum: + - Cancel + - Process + description: An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. + EnhancedCashFlowTransactions: + title: Enhanced cash flow transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + dataSources: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/dataSource' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem' + definitions: + dataSource: + type: object + properties: + accounts: + description: 'An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.' + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts' + accounts: + title: Accounts + type: object + properties: + sourceRef: + title: Report source reference + description: A source reference containing the `sourceType` object "Banking". + type: object + properties: + sourceType: + description: The data source type. + type: string + examples: + - Example: + value: + sourceRef: + sourceType: Banking + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + enhancedCashFlowItem: + type: object + properties: + transactions: + description: An array of transaction data. + type: array + items: + title: Cash flow transaction + type: object + properties: + id: + description: The unique identifier of the bank transaction. + type: string + date: + description: The date the bank transaction was posted. + $ref: '#/components/schemas/DateTime' + description: + description: The description of the bank transaction. + type: string + amount: + description: The bank transaction amount. + type: number + format: decimal + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for bank transaction. + transactionCategory: + description: Contains an array of category levels. + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/transactionCategory' + platformName: + description: Returns the payment processor responsible for the transaction. + type: string + counterpartyNames: + description: An array of counterparty names involved in the transaction. + type: array + items: + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + accountRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/accountRef' + modifiedDate: + description: The date the bank transaction was last modified. + $ref: '#/components/schemas/DateTime' + definitions: + accountRef: + title: Account reference + description: An account reference containing the account id and name. + type: object + properties: + id: + description: The id of the account. + type: string + name: + description: The name of the account. + type: string + examples: + - Example: + value: + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + transactionCategory: + title: Transaction category + type: object + properties: + confidence: + description: Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100. + type: number + format: decimal + confidences: + description: An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array. + type: array + items: + type: number + format: decimal + levels: + description: The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). + type: array + items: + type: string + examples: + - Example: + value: + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + - BankTransfers + - ShareholderTransfers + confidences: + - 92.7 + - 95 + - 96 + - 97.5 + - 100 + examples: + - reportInfo: + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + reportName: Cash Flow transactions report + companyName: Example Company + generatedDate: '2023-01-25T22:36:05.125Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Current Account + accountType: Debit + currency: USD + currentBalance: 1000 + identifiers: + - type: Debit + subType: Current + number: 12345678 + bankCode: 123456 + iban: US123456789 + bic: US123456789 + maskedAccountNumber: 1234 + - sourceRef: + sourceType: Banking + id: 12345678-1234-1234-1234-123456789012 + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Saving Account + accountType: Debit + currency: USD + currentBalance: 5321 + identifiers: + - type: Debit + subType: Saving + number: 87654321 + bankCode: 654321 + iban: US987654321 + bic: US987654321 + maskedAccountNumber: 4321 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: null + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + EnhancedFinancialReport: + title: Enhanced report + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportInfo' + reportItems: + type: array + description: An array of report items. + items: + title: Report item + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Last date of the period. + balance: + type: number + format: decimal + description: Balance of the account as reported on the profit and loss or Balance sheet. + accountName: + type: string + description: Name of the account. + accountId: + type: string + description: The unique account ID. + accountCategory: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportAccountCategory' + definitions: + enhancedReportAccountCategory: + title: Account category + descrciption: 'An object containing the suggested or confirmed account categories, up to five levels.' + type: object + properties: + status: + type: string + description: 'Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned.' + levels: + type: array + items: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/accountCategoryLevel' + accountCategoryLevel: + title: Account category level + description: An object containing an ordered list of account category levels. + type: object + properties: + levelName: + type: string + description: Account category name. + confidence: + type: number + format: decimal + description: Confidence level of the category. This will only be populated where `status` is `Suggested`. + enhancedReportInfo: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the P&L/Balance sheet. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + examples: + - reportInfo: + reportName: EnhancedProfitAndLossAccounts + companyName: ABC LTD + generatedDate: '2022-01-01' + reportItems: + - date: '2022-01-01' + balance: 70 + accountName: Sales UK + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 30 + accountName: Sales US + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 70 + accountName: Amazon + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.95 + - levelName: Online + confidence: 0.8 + EnhancedInvoicesReport: + title: Enhanced invoices report + description: The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by matching with the bank statement. + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/enhancedInvoiceReportItem' + definitions: + lendingCustomerRef: + type: object + properties: + id: + minLength: 1 + type: string + description: '`id` from the Customers data type.' + customerName: + type: string + nullable: true + description: '`customerName` from the Customer data type.' + payment: + title: Enhanced invoice payment item + type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + date: + $ref: '#/components/schemas/DateTime' + paymentType: + type: string + description: The type of payment. + amount: + type: number + format: decimal + description: Payment amount. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + bankingTransactionRefs: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/bankingTransactionRef' + bankingTransactionRef: + title: Banking transaction reference + type: object + properties: + id: + type: string + description: Unique identifier for the bank transaction. + dataConnectionId: + type: string + description: Unique identifier of the bank transaction's connection. + accountId: + type: string + description: Unique identifier of the bank transaction's account. + accountName: + type: string + description: Name given to account. + date: + $ref: '#/components/schemas/DateTime' + description: + type: string + description: Description given to bank transaction. + amount: + type: number + description: Bank transaction amount. + format: decimal + invoiceStatus: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + enhancedInvoiceReportItem: + title: Enhanced invoice report item + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + invoiceNumber: + type: string + description: Invoice number. + customerRef: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/lendingCustomerRef' + issueDate: + $ref: '#/components/schemas/DateTime' + dueDate: + $ref: '#/components/schemas/DateTime' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + totalAmount: + type: number + format: decimal + description: Invoice's total amount. + amountDue: + type: number + format: decimal + description: Invoice's total amount due. + payments: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/payment' + paidOnDate: + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + reportInfo: + title: Report information + type: object + description: 'Report additional information, which is specific to Lending reports.' + properties: + pageNumber: + type: integer + description: The number of the page queried. + pageSize: + type: integer + description: The number of transactions returned per page. + totalResults: + type: integer + description: The total number of transactions available for a company for the period specified in the query string. + reportName: + type: string + description: Name of the report. + companyName: + type: string + description: The name of the company being queried. + generatedDate: + type: string + description: Date the report was generated. + examples: + - Example 1: + value: + pageNumber: 0 + pageSize: 0 + totalResults: 0 + reportName: string + companyName: string + generatedDate: '2023-01-26T07:36:40.487Z' + ErrorMessage: + title: Error message + type: object + x-internal: true + properties: + statusCode: + type: integer + description: The HTTP status code returned by the error. + service: + type: string + description: Codat's service the returned the error. + error: + type: string + description: A brief description of the error. + correlationId: + type: string + description: Unique identifier used to propagate to all downstream services and determine the source of the error. + validation: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidation' + canBeRetried: + type: string + description: '`True` if the error occurred transiently and can be retried.' + detailedErrorCode: + type: integer + description: Machine readable error code used to automate processes based on the code returned. + definitions: + errorValidation: + title: Validation error + type: object + nullable: true + description: 'A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.' + properties: + errors: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + warnings: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + errorValidationItem: + title: Validation error item + type: object + properties: + itemId: + type: string + nullable: true + description: Unique identifier for a validation item. + message: + type: string + nullable: true + description: A message outlining validation item's issue. + validatorName: + type: string + nullable: true + description: Name of validator. + ExcelStatus: + type: object + title: Excel status + properties: + lastGenerated: + $ref: '#/components/schemas/DateTime' + description: The date and time of when the generation of the most recent report was initiated. + inProgress: + type: boolean + description: 'When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.' + queued: + type: string + description: The date and time of when a successful request was queued for the most recent report. + success: + type: boolean + description: True if the requested report was successfully queued and false if the requested report was not able to be queued. + errorMessage: + type: string + description: Error details in case the report generation request was unsuccessful. + lastInvocationId: + type: string + description: A unique ID generated for this request. + reportType: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + fileSize: + type: integer + nullable: true + description: The file size in Bytes is populated upon successful generation of the report. + definitions: + excelReportTypes: + type: string + enum: + - audit + - enhancedFinancials + - enhancedInvoices + - enhancedCashFlow + description: The type of the report requested in the query string. + examples: + - lastGenerated: '2023-01-25T22:36:05.125Z' + inProgress: true + queued: '2023-01-25T22:36:05.125Z' + success: true + errorMessage: string + lastInvocationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + reportType: string + fileSize: 0 + File: + title: File + type: object + properties: + fileName: + type: string + nullable: true + description: The file's name. + displayName: + type: string + nullable: true + description: An optional display name for the file. + sourceType: + type: string + nullable: true + description: The source of the file uploaded. + uploaded: + $ref: '#/components/schemas/DateTime' + additionalProperties: false + Files: + title: Files + type: array + items: + $ref: '#/components/schemas/File' + FileUpload: + title: Attachment upload + type: object + x-internal: true + required: + - file + properties: + file: + $ref: '#/components/schemas/FileUpload/definitions/codatFile' + definitions: + codatFile: + type: string + description: The file to be uploaded as an attachment. + format: binary + FinancialSummary: + title: Closed Books Indicator + type: object + properties: + booksClosedDate: + type: object + description: The date time in UTC the books closed. + properties: + date: + type: string + format: date-time + description: The date time in UTC the books closed. + example: '2025-05-31T00:00:00Z' + reason: + type: array + description: List of reasons explaining the books closed date. + items: + type: string + example: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + type: object + description: 'A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.' + properties: + score: + type: number + format: decimal + description: The accounting score value. + example: 90 + reason: + type: array + description: List of reasons explaining the accounting score. + items: + type: string + example: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + LoanSummary: + title: Loan summary + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportInfo' + reportItems: + type: array + description: Returns a summary of all loan activity for that integration type + items: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportItem' + definitions: + loanSummaryReportInfo: + title: Loan Summary Report Info + type: object + properties: + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. urns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + x-stoplight: + id: vrnhmgrfndjhh + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + loanSummaryRecordRef: + title: Item reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + integrationType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryIntegrationType' + recordRefType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRefType' + loanSummaryReportItem: + type: object + properties: + recordRef: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRef' + description: Contains object that contains a summary of all loan transactions for that integration type. + description: + type: string + description: The description of the object being referred to. E.g. the account. + startDate: + $ref: '#/components/schemas/DateTime' + description: The date of the earliest loan transaction. + totalDrawdowns: + type: number + format: decimal + description: The total loan drawdowns. + totalRepayments: + type: number + format: decimal + description: The total loan repayments which includes capital plus any interest. + balance: + type: number + format: decimal + description: The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. + lender: + type: string + description: The name of lender providing the loan. + loanSummaryIntegrationType: + title: Integration type + type: string + enum: + - Accounting + - Banking + - Commerce + description: The integration type begin referred to. + loanSummaryRecordRefType: + title: Record reference type + type: string + enum: + - accounts + - banking-accounts + - commerce-transactions + description: The datatype being referred to. + examples: + - reportInfo: + reportName: LoanSummaryReport + companyName: The Coffee shop + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - recordRef: + id: string + dataConnectionId: DE34E8E3-089F-4DF4-89E9-F7C43618FCAAA + integrationType: Accounting + recordRefType: accounts + description: string + startDate: '2021-01-01' + totalInvestments: 100000 + totalRepayments: 83481.72 + balance: 42513.18 + lender: Barclays Bank + LoanTransactions: + title: Loan transactions + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanTransactions/definitions/loanTransactionsReportInfo' + reportItems: + type: array + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + items: + $ref: '#/components/schemas/LoanTransactions/definitions/reportItems' + definitions: + loanTransactionsReportInfo: + title: Loan Transactions Report Info + type: object + properties: + pageNumber: + type: integer + description: The page number. + pageSize: + type: integer + description: Queried page size. + totalResults: + type: integer + description: The total number of transactions returned. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + itemRef: + title: Item reference + type: object + properties: + id: + type: string + description: 'The id of the object, e.g. the Journal entry.' + dataConnectionId: + type: string + description: The data connection id being referenced. + type: + type: string + description: The data type the loan transaction entry was extracted from. + reportItems: + type: object + properties: + loanRef: + $ref: '#/components/schemas/LoanTransactions/definitions/loanRef' + description: Contains object that contains all the Loan transactions for that integration type. + itemRef: + $ref: '#/components/schemas/LoanTransactions/definitions/itemRef' + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + date: + $ref: '#/components/schemas/DateTime' + description: The date of that entry type occurred. + amount: + type: number + format: decimal + description: The loan transaction amount. + loanTransactionType: + description: The type of loan transaction. + type: string + enum: + - Investment + - Repayment + - Interest + - AccuredInterest + lender: + type: string + description: The name of lender providing the loan. + examples: + - reportInfo: + pageNumber: 1 + pageSize: 1000 + totalResults: 1 + reportName: AccountingLoanTransactions + companyName: Supermarket store + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - loanRef: + id: '332' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: chartOfAccount + itemRef: + id: '755488' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: journalEntry + date: '2020-08-02' + amount: -455 + transactionType: Repayment + lender: Barclays Bank + Metadata: + title: Metadata + type: object + x-internal: true + properties: + isDeleted: + type: boolean + description: Indicates whether the record has been deleted in the third-party system this record originated from. + nullable: true + PagingInfo: + type: object + title: Pagination information + x-internal: true + properties: + pageNumber: + type: integer + description: Current page number. + pageSize: + type: integer + description: Number of items to return in results array. + maximum: 2000 + totalResults: + type: integer + description: Total number of items. + _links: + $ref: '#/components/schemas/PagingInfo/definitions/links' + definitions: + links: + title: Hal Links + type: object + required: + - self + - current + properties: + self: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + current: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + next: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + previous: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + examples: + - self: + href: /companies + current: + href: /companies?page=1&pageSize=10 + halRef: + title: Hypertext reference + type: object + properties: + href: + type: string + format: uri-reference + description: Uri hypertext reference. + required: + - pageNumber + - pageSize + - totalResults + - _links + examples: + - pageNumber: 1 + pageSize: 10 + totalResults: 1 + _links: + self: + href: '/companies/{id}/data/{dataType}' + current: + href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + PaymentMethodRef: + type: object + title: Payment method reference + description: The payment method the record is linked to in the accounting or commerce software. + properties: + id: + description: The unique identifier of the location being referenced. + type: string + name: + description: Name of the location being referenced. + type: string + required: + - id + example: + id: EILBDVJVNUAGVKRQ + name: AliPay + PhoneNumber: + title: Phone + type: object + x-internal: true + properties: + number: + type: string + nullable: true + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + description: A phone number. + type: + description: The type of phone number + type: string + enum: + - Primary + - Landline + - Mobile + - Fax + - Unknown + required: + - type + ProjectRef: + title: 'Accounting: Project reference' + x-internal: true + required: + - id + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the project reference. + name: + type: string + nullable: true + description: The project's name. + PullOperation: + title: Pull operation + description: |- + Information about a queued, in progress or completed pull operation. + *Formally called `dataset`* + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier of the pull operation. + example: 943accd0-4247-42d8-865b-363c8629e1da + companyId: + type: string + format: uuid + description: Unique identifier of the company associated to this pull operation. + example: 22ece347-e5f6-4896-95e0-35a4c7f17023 + connectionId: + type: string + format: uuid + description: Unique identifier of the connection associated to this pull operation. + example: 50830828-7d39-4367-b0eb-5ddb2de5faa5 + dataType: + title: Data types + x-internal: true + type: string + description: The data type you are requesting in a pull operation. + status: + title: Dataset status + type: string + description: The current status of the dataset. + enum: + - Initial + - Queued + - Fetching + - MapQueued + - Mapping + - Complete + - FetchError + - MapError + - InternalError + - ProcessingQueued + - Processing + - ProcessingError + - ValidationQueued + - Validating + - ValidationError + - AuthError + - Cancelled + - NotSupported + - RateLimitError + - PermissionsError + - PrerequisiteNotMet + statusDescription: + type: string + nullable: true + description: Additional information about the dataset status. + example: 'Paused until 2022-10-23T00:00:00.000Z' + errorMessage: + type: string + nullable: true + description: A message about a transient or persistent error returned by Codat or the source platform. + requested: + $ref: '#/components/schemas/DateTime' + completed: + $ref: '#/components/schemas/DateTime' + progress: + type: integer + description: An integer signifying the progress of the pull operation. + isCompleted: + type: boolean + description: '`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: + type: boolean + description: '`True` if the pull operation entered an error state.' + required: + - id + - companyId + - connectionId + - dataType + - status + - requested + - progress + - isCompleted + - isErrored + examples: + - 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 + PullOperations: + title: Pull operations + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/PullOperation' + - $ref: '#/components/schemas/PagingInfo' + PushOperation: + title: Push operation + type: object + x-internal: true + properties: + changes: + type: array + nullable: true + description: 'Contains a single entry that communicates which record has changed and the manner in which it changed. ' + items: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationChange' + dataType: + $ref: '#/components/schemas/DataStatus/properties/dataType' + description: 'The type of data being pushed, eg invoices, customers.' + companyId: + $ref: '#/components/parameters/companyId/schema' + pushOperationKey: + type: string + format: uuid + description: '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.' + dataConnectionKey: + $ref: '#/components/parameters/connectionId/schema' + requestedOnUtc: + $ref: '#/components/schemas/DateTime' + description: The datetime when the push was requested. + completedOnUtc: + $ref: '#/components/schemas/DateTime' + description: 'The datetime when the push was completed, null if Pending.' + timeoutInMinutes: + type: integer + format: int32 + nullable: true + description: Number of minutes the push operation must complete within before it times out. + timeoutInSeconds: + type: integer + format: int32 + nullable: true + deprecated: true + description: Number of seconds the push operation must complete within before it times out. + status: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationStatus' + errorMessage: + type: string + nullable: true + description: A message about the error. + validation: + $ref: '#/components/schemas/PushOperation/definitions/validation' + statusCode: + type: integer + description: Push status code. + required: + - companyId + - pushOperationKey + - dataConnectionKey + - requestedOnUtc + - status + - statusCode + definitions: + validation: + type: object + title: Validation + description: '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.' + properties: + errors: + type: array + nullable: true + items: + $ref: '#/components/schemas/PushOperation/definitions/validationItem' + warnings: + type: array + nullable: true + items: + $ref: '#/components/schemas/PushOperation/definitions/validationItem' + validationItem: + title: Validation item + type: object + properties: + itemId: + type: string + nullable: true + description: Unique identifier for a validation item. + message: + type: string + nullable: true + description: A message outlining validation item's issue. + validatorName: + type: string + nullable: true + description: Name of validator. + additionalProperties: false + pushChangeType: + title: Push change type + description: Type of change being applied to record in third party platform. + type: string + enum: + - Unknown + - Created + - Modified + - Deleted + - AttachmentUploaded + pushOperationRef: + title: Push operation reference + x-internal: true + type: object + properties: + id: + type: string + description: Unique identifier for a push operation. + dataType: + $ref: '#/components/schemas/DataStatus/properties/dataType' + nullable: true + additionalProperties: false + pushOperationStatus: + title: Push operation status + type: string + enum: + - Pending + - Failed + - Success + - TimedOut + description: The current status of the push operation. + pushOperationChange: + type: object + properties: + type: + $ref: '#/components/schemas/PushOperation/definitions/pushChangeType' + recordRef: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationRef' + attachmentId: + type: string + description: Unique identifier for the attachment created otherwise null. + nullable: true + PushOperations: + title: Push operations + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/PushOperation' + - $ref: '#/components/schemas/PagingInfo' + PushOption: + title: Push option + x-internal: true + required: + - displayName + - required + - type + type: object + properties: + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName' + description: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' + required: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty' + nullable: true + options: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushOptionChoice' + nullable: true + validation: + $ref: '#/components/schemas/PushOption/definitions/pushValidationInfo' + nullable: true + definitions: + pushOptionProperty: + title: Push Option Property + required: + - description + - displayName + - required + - type + type: object + properties: + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + minLength: 1 + type: string + description: The property's display name. + description: + type: string + description: A description of the property. + required: + type: boolean + description: The property is required if `True`. + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty' + nullable: true + options: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushOptionChoice' + nullable: true + validation: + $ref: '#/components/schemas/PushOption/definitions/pushValidationInfo' + pushValidationInfo: + title: Push validation info + type: object + properties: + warnings: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushFieldValidation' + nullable: true + information: + type: array + items: + $ref: '#/components/schemas/PushOption/definitions/pushFieldValidation' + nullable: true + additionalProperties: false + pushFieldValidation: + title: Push field validation + required: + - details + type: object + properties: + field: + type: string + description: Field name that resulted in the validation issue. + details: + minLength: 1 + type: string + description: Details on the validation issue. + ref: + type: string + format: uri + nullable: true + description: Unique reference identifier for the validation issue. + additionalProperties: false + pushOptionType: + title: Option Type + description: The option type. + enum: + - Array + - Object + - String + - Number + - Boolean + - DateTime + - File + - MultiPart + type: string + pushOptionChoice: + title: Push Option Choice + type: object + properties: + value: + type: string + minLength: 1 + description: Allowed value for field. + type: + $ref: '#/components/schemas/PushOption/definitions/pushOptionType' + displayName: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName' + description: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' + required: + $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + ReportLine: + x-internal: true + type: object + title: 'Accounting: Report line' + properties: + accountId: + type: string + nullable: true + description: 'Identifier for the account, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the report line item. + value: + type: number + format: decimal + description: Numerical value of the line item. + items: + type: array + nullable: true + description: An array of ReportLine items. + items: + $ref: '#/components/schemas/ReportLine' + required: + - value + ReportOperation: + title: Report + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier of the report + example: 52c0f26b-051a-43ff-b02a-258eec67f5ef + status: + type: string + enum: + - InProgress + - Complete + - Error + description: The status of the report generation. + type: + type: string + enum: + - categorizedBankStatement + - creditModel + - spendAnalysis + description: The name of the generated report. + requestedDate: + description: The date and time on which the report was requested. + $ref: '#/components/schemas/DateTime' + updatedDate: + description: The date and time on which the report was last updated. + $ref: '#/components/schemas/DateTime' + errorMessage: + type: string + nullable: true + description: A short message describing any errors that occurred while generating the report. + description: Information about report generation. + definitions: + reports: + title: Reports + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/ReportOperation' + minLength: 0 + maxLength: 2000 + - $ref: '#/components/schemas/PagingInfo' + SourceAccount: + title: Source account (v1) + type: object + description: The target bank account in a supported accounting software for ingestion into a bank feed. + additionalProperties: false + properties: + id: + type: string + description: Unique ID for the bank account. + accountName: + type: string + nullable: true + description: The bank account name. + accountType: + type: string + nullable: true + description: The type of bank account e.g. Credit. + accountNumber: + type: string + nullable: true + description: The account number. + sortCode: + type: string + nullable: true + description: The sort code. + currency: + title: Currency + x-internal: true + type: string + description: "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system." + format: ISO4217 + examples: + - GBP + - USD + - EUR + balance: + type: number + format: decimal + nullable: true + description: The latest balance for the bank account. + modifiedDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The last date the bank account was modified. + status: + type: string + nullable: true + description: Status of the source account. + enum: + - pending + - connected + - connecting + - disconnected + - unknown + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + required: + - id + definitions: + sourceAccountPrototype: + title: Source account (v1) + type: object + properties: + id: + $ref: '#/components/schemas/SourceAccount/properties/id' + accountName: + $ref: '#/components/schemas/SourceAccount/properties/accountName' + accountType: + $ref: '#/components/schemas/SourceAccount/properties/accountType' + accountNumber: + $ref: '#/components/schemas/SourceAccount/properties/accountNumber' + sortCode: + $ref: '#/components/schemas/SourceAccount/properties/sortCode' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + balance: + $ref: '#/components/schemas/SourceAccount/properties/balance' + modifiedDate: + $ref: '#/components/schemas/SourceAccount/properties/modifiedDate' + required: + - id + sourceAccounts: + title: Source accounts + type: array + items: + $ref: '#/components/schemas/SourceAccount' + examples: + - id: acc-002 + accountName: account-081 + sortCode: '123456' + accountType: Credit + accountNumber: '12345670' + currency: GBP + balance: 99.99 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + status: pending + - id: acc-003 + accountName: account-095 + sortCode: '123456' + accountType: Credit + accountNumber: '12345671' + currency: USD + balance: 0 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + status: pending + SourceAccountV2: + title: Source account (v2) + type: object + description: The target bank account in a supported accounting software for ingestion into a bank feed. + additionalProperties: false + properties: + id: + type: string + description: Unique ID for the bank account. + accountName: + type: string + description: The bank account name. + accountType: + type: string + description: 'The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.' + enum: + - checking + - savings + - loan + - creditCard + - prepaidCard + accountNumber: + type: string + description: The account number. + sortCode: + type: string + nullable: true + description: The sort code. + routingInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + balance: + type: number + format: decimal + description: The latest balance for the bank account. + accountInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' + modifiedDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The last date the bank account was modified. + status: + type: string + nullable: true + description: Status of the source account. + enum: + - pending + - connected + - connecting + - disconnected + - unknown + feedStartDate: + nullable: true + title: Date + type: string + example: '2022-10-23' + description: |- + In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example: + ``` + 2020-10-08 + ``` + required: + - id + - accountName + - accountType + - accountNumber + - currency + - balance + definitions: + sourceAccountV2Prototype: + title: Source account (v2) + type: object + properties: + id: + $ref: '#/components/schemas/SourceAccountV2/properties/id' + accountName: + $ref: '#/components/schemas/SourceAccountV2/properties/accountName' + accountType: + $ref: '#/components/schemas/SourceAccountV2/properties/accountType' + accountNumber: + $ref: '#/components/schemas/SourceAccountV2/properties/accountNumber' + routingInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' + sortCode: + $ref: '#/components/schemas/SourceAccountV2/properties/sortCode' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + balance: + $ref: '#/components/schemas/SourceAccountV2/properties/balance' + modifiedDate: + $ref: '#/components/schemas/SourceAccountV2/properties/modifiedDate' + accountInfo: + $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' + required: + - id + - accountName + - accountType + - accountNumber + - currency + - balance + accountInfo: + title: Account Info + type: object + nullable: true + properties: + description: + type: string + nullable: true + description: Description of the account. + nickname: + type: string + nullable: true + description: Name given to the account by the user. Used in UIs to assist in account selection. + accountOpenDate: + $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' + nullable: true + description: Date when the account was opened or created at the provider + availableBalance: + type: number + format: decimal + nullable: true + description: Balance of funds available for use. This includes pending activity. + sourceAccounts: + title: Source accounts + type: array + items: + $ref: '#/components/schemas/SourceAccountV2' + routingInfo: + title: Routing Info + type: object + description: Routing information for the bank. This does not include account number. + properties: + bankCode: + type: string + nullable: true + description: The numeric identifier of the routing number + type: + type: string + nullable: true + default: bankcode + enum: + - rtn + - aba + - swift + - bsb + - iban + - nz2 + - trno + - sortcode + - blz + - ifsc + - bankcode + - apca + - clabe + description: The type of routing number. + examples: + - id: acc-001 + accountName: account-081 + accountType: checking + accountNumber: '12345670' + routingInfo: + bankCode: 021001088 + type: bankcode + currency: GBP + balance: 99.99 + accountInfo: + description: account description 1 + nickname: account 123 + accountOpenDate: '2023-05-06' + availableBalance: 10 + modifiedDate: '2024-08-02T00:00:00.000Z' + status: pending + feedStartDate: '2024-05-01' + - id: acc-002 + accountName: account-083 + accountType: savings + accountNumber: '23456789' + routingInfo: + bankCode: 021001088 + type: bankcode + currency: GBP + balance: 400 + accountInfo: + description: account description 2 + nickname: account 1290 + accountOpenDate: '2023-05-23' + availableBalance: 400 + modifiedDate: '2024-08-02T00:00:00.000Z' + status: pending + feedStartDate: '2024-05-01' + StartUploadSessionRequest: + title: Upload session start request + type: object + properties: + dataType: + type: string + enum: + - banking-accounts + - banking-transactions + description: A key for a Codat data type. + SupplementalData: + title: Supplemental data + type: object + x-internal: true + description: "Supplemental data is additional data you can include in our standard data types. \n\nIt 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." + properties: + content: + type: object + additionalProperties: + type: object + additionalProperties: true + nullable: true + ThirdPartySchema: + title: Third-party schema + description: The format should be identical to the file format receieved from the third-party banking source (e.g. Plaid or TrueLayer). + type: object + x-speakeasy-type-override: any + WebLink: + title: Weblink + description: Weblink associated with the company. + type: object + properties: + type: + description: The type of the weblink. + type: string + enum: + - Website + - Social + - Unknown + url: + description: The full URL for the weblink. + type: string + format: url + example: + type: Website + url: 'https://codat.io' + parameters: + page: + name: page + in: query + schema: + type: integer + format: int32 + minimum: 1 + example: 1 + default: 1 + description: 'Page number. [Read more](https://docs.codat.io/using-the-api/paging).' + pageSize: + name: pageSize + in: query + schema: + type: integer + format: int32 + default: 100 + example: 100 + minimum: 1 + maximum: 5000 + description: 'Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).' + query: + name: query + in: query + required: false + schema: + type: string + example: id=e3334455-1aed-4e71-ab43-6bccf12092ee + description: 'Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).' + orderBy: + name: orderBy + in: query + required: false + schema: + type: string + example: '-modifiedDate' + description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' + companyId: + name: companyId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId + in: path + required: true + schema: + type: string + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. + dataType: + name: dataType + description: A key for a Codat data type. + in: path + required: true + schema: + $ref: '#/components/schemas/DataType' + datasetId: + name: datasetId + in: path + required: true + schema: + type: string + format: uuid + description: Unique identifier for the dataset that completed its sync. + description: Unique identifier for the dataset that completed its sync. + dataIntegrityDataType: + name: dataType + in: path + required: true + schema: + type: string + enum: + - banking-accounts + - banking-transactions + - bankAccounts + - accountTransactions + example: banking-accounts + description: A key for a Codat data type. + reportDate: + name: reportDate + in: query + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + reportDateRequired: + name: reportDate + in: query + required: true + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + periodLength: + name: periodLength + in: query + required: true + schema: + type: integer + description: The number of months per period. E.g. 2 = 2 months per period. + numberOfPeriods: + name: numberOfPeriods + in: query + required: false + schema: + type: integer + description: 'The number of periods to return. If not provided, 12 periods will be used as the default value.' + numberOfPeriodsRequired: + name: numberOfPeriods + in: query + required: true + schema: + type: integer + description: The number of periods to return. There will be no pagination as a query parameter. + periodUnit: + name: periodUnit + in: query + required: true + schema: + type: string + enum: + - Day + - Week + - Month + - Year + description: The period unit of time returned. + includeDisplayNames: + name: includeDisplayNames + in: query + schema: + type: boolean + description: Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. + excelReportType: + name: reportType + in: query + schema: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + description: The type of report you want to generate and download. + required: true + accountingAccountId: + name: accountId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an account. + accountingBillPaymentId: + name: billPaymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill payment. + accountingBillId: + name: billId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill. + attachmentId: + name: attachmentId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for an attachment. + accountingDirectCostId: + name: directCostId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct cost. + accountingDirectIncomeId: + name: directIncomeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct income. + accountingInvoiceId: + name: invoiceId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an invoice. + accountingSupplierId: + name: supplierId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a supplier. + accountingReportDate: + name: reportDate + in: query + schema: + type: string + format: date + example: '2022-12-31' + description: Date the report is generated up to. + accountingNumberOfPeriods: + name: numberOfPeriods + in: query + schema: + type: integer + format: int32 + example: 12 + description: Number of periods to include in the report. + accountingPeriodLengthDays: + name: periodLengthDays + in: query + schema: + type: integer + format: int32 + example: 30 + description: The length of period in days. + accountingPeriodLength: + name: periodLength + description: Number of months defining the period of interest. + in: query + required: true + schema: + type: integer + format: int32 + example: 4 + accountingPeriodsToCompare: + name: periodsToCompare + description: Number of periods with `periodLength` to compare. + in: query + required: true + schema: + type: integer + format: int32 + example: 20 + accountingStartMonth: + name: startMonth + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: The month the report starts from. + customerId: + name: customerId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a customer. + timeoutInMinutes: + name: timeoutInMinutes + in: query + schema: + type: integer + format: int32 + description: Time limit for the push operation to complete before it is timed out. + allowSyncOnPushComplete: + name: allowSyncOnPushComplete + in: query + schema: + type: boolean + default: true + description: Allow a sync upon push completion. + forceUpdate: + name: forceUpdate + in: query + schema: + type: boolean + default: false + description: '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.' + pushOperationKey: + name: pushOperationKey + schema: + type: string + format: uuid + in: path + required: true + description: Unique identifier for the push operation. + paymentId: + name: paymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment. + productId: + name: productId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a product. + path: + name: path + description: The endpoint path of the third-party banking service that the request body originates from. Only required if the source is not `codat`. + in: query + required: false + schema: + type: string + enum: + - auth/get + reportType: + name: reportType + description: The type of the report + in: path + required: true + schema: + type: string + enum: + - categorizedBankStatement + - creditModel + reportId: + name: reportId + description: 'Unique identifier for a report, use either the Id of the report or `latest` for the most recently generate report.' + in: path + required: true + schema: + oneOf: + - type: string + title: ID + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + - type: string + title: Latest + enum: + - latest + maxAge: + description: The maximum age of report to fetch. + name: maxAge + in: query + required: false + schema: + $ref: '#/components/schemas/DateTime' + responses: + BadRequest: + description: The request made is not valid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Malformed query: + value: + statusCode: 400 + service: PublicApi + error: Error processing request - not valid. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Malformed-Query: + description: Your `query` parameter was not correctly formed + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Malformed query: + value: + statusCode: 400 + service: ClientsApi + error: Error parsing query - Malformed query. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Unresolved property: + value: + statusCode: 400 + service: PullApi + error: Error parsing query - Could not resolve property isCompleted on Dataset + correlationId: 98457fb9956b7f9b4b2fd4f6e23bb5c8 + canBeRetried: Unknown + detailedErrorCode: 0 + Unauthorized: + description: Your API request was not properly authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Unauthorized: + value: + statusCode: 401 + service: PublicApi + error: Unauthorized + correlationId: 7eb40d6b415d7bcd99ce658268284056 + canBeRetried: Unknown + detailedErrorCode: 0 + Payment-Required: + description: | + An account limit has been exceeded. The type of limit is described in the error property: + + - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. + - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. + - Your Free account is older than 365 days and has expired. Contact support@codat.io. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 429 + service: PublicApi + error: You have exceeded the 50-company limit that applies to a Free plan. We recommend that you delete any companies you no longer need and retry the request. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Forbidden: + description: You are using an outdated API key or a key not associated with that resource. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 403 + service: PublicApi + error: You are using an outdated API key or a key not associated with that resource. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Not-Found: + description: |- + One or more of the resources you referenced could not be found. + This might be because your company or data connection id is wrong, or was already deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Data connection not found: + value: + statusCode: 404 + service: PublicApi + error: Data connection a22dd66b-564a-4832-9b37-7b3ce4aeb7de not found + correlationId: 8fa2b5f4794970a4ee73758f612e8df0 + canBeRetried: Unknown + detailedErrorCode: 0 + Company not found: + value: + statusCode: 404 + service: ClientsApi + error: No company was found with ID 846ed55c-974b-4392-a1f1-87b6fdbf3c5e + correlationId: 0a40c2f31fc8f992fb88b0853e4166f3 + canBeRetried: Unknown + detailedErrorCode: 0 + No data available: + value: + statusCode: 404 + service: PublicApi + error: No data available for accounts for ID e5889b459f544926ac5b8e6756df2s + correlationId: 0a40c2f31fc8f992fb88b0853e4166f3 + canBeRetried: Unknown + detailedErrorCode: 0 + Conflict: + description: The data type's dataset has not been requested or is still syncing. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 409 + service: PublicApi + error: The data set has not been requested. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Too-Many-Requests: + description: Too many requests were made in a given amount of time. Wait a short period and then try again. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 429 + service: PublicApi + error: You have made too many requests in a given amount of time; please retry later. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Internal-Server-Error: + description: There is a problem with our server. Please try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 500 + service: PublicApi + error: There is a problem with our server. Please try again later. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + Service-Unavailable: + description: The Codat API is temporarily offline for maintenance. Please try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 500 + service: PublicApi + error: The Codat API is temporarily offline for maintenance. Please try again later. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 + securitySchemes: + auth_header: + name: Authorization + description: 'The word "Basic" followed by a space and your API key. [API keys](https://docs.codat.io/platform-api#/schemas/ApiKeyDetails) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/platform-api#/operations/list-api-keys), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.' + type: apiKey + in: header + x-speakeasy-example: Basic BASE_64_ENCODED(API_KEY) + examples: + CodatBankStatementUploadConfiguration: + value: + source: codat + accountId: abc123-ABC + summary: Settings for uploading codat data + EnhancedCashflowExample: + value: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 2194 + reportName: Cash flow transactions report + companyName: test + generatedDate: '2023-03-24T16:44:17.5302732Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + SingleReportExample: + value: + id: 6e9bae88-72c9-45ae-abe8-41fbf2871458 + status: InProgress + type: categorizedBankStatement + requestedDate: '2024-09-27T04:43:41Z' + updatedDate: '2024-10-01T14:41:46Z' diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 7b0ae60fe..22b729f25 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.696.0 +speakeasyVersion: 1.701.0 sources: bank-feeds-source: sourceNamespace: bank-feeds-source @@ -10,11 +10,11 @@ sources: - 3.0.0 lending-source: sourceNamespace: lending-source - sourceRevisionDigest: sha256:e0aed482c0ce3a529744105147d2857d2fcd03a79bd8e8d82b07892cffe0bb9e - sourceBlobDigest: sha256:d1d88be3211e4012cc3f3beab27e7d09c3a7a20b5c5eccc31eda1bab664f033d + sourceRevisionDigest: sha256:7149d024c5bf2bf2ebf21d7a0dd81541b8737274458d8a3535c66bae43ec52f4 + sourceBlobDigest: sha256:f44b8b8db2e4c91dc3b443995ba4912363c5ae28b0b762c386273adef38bd4ed tags: - latest - - speakeasy-sdk-regen-1769004467 + - speakeasy-sdk-regen-1770204374 - 3.0.0 platform-source: sourceNamespace: platform-source @@ -73,10 +73,10 @@ targets: lending-library: source: lending-source sourceNamespace: lending-source - sourceRevisionDigest: sha256:e0aed482c0ce3a529744105147d2857d2fcd03a79bd8e8d82b07892cffe0bb9e - sourceBlobDigest: sha256:d1d88be3211e4012cc3f3beab27e7d09c3a7a20b5c5eccc31eda1bab664f033d + sourceRevisionDigest: sha256:7149d024c5bf2bf2ebf21d7a0dd81541b8737274458d8a3535c66bae43ec52f4 + sourceBlobDigest: sha256:f44b8b8db2e4c91dc3b443995ba4912363c5ae28b0b762c386273adef38bd4ed codeSamplesNamespace: lending-source-csharp-code-samples - codeSamplesRevisionDigest: sha256:b89807e35987cc337e034d681db52964baae2d83eac9e41fa6e0442cbf3c88f6 + codeSamplesRevisionDigest: sha256:3e4978bd8e0f762acc2df2152f45fb793431920135d23f2cb5d641853facc25f platform-library: source: platform-source sourceNamespace: platform-source diff --git a/lending/.speakeasy/gen.lock b/lending/.speakeasy/gen.lock index 2344a6c5b..231c0e3b3 100755 --- a/lending/.speakeasy/gen.lock +++ b/lending/.speakeasy/gen.lock @@ -1,24 +1,24 @@ lockVersion: 2.0.0 id: 35d91636-e73c-4697-a088-5369539eda61 management: - docChecksum: 4da6c8cf4dbb6342ba330ea8560f587d + docChecksum: 9c447111606083b3e909a159cdbccbff docVersion: 3.0.0 - speakeasyVersion: 1.692.0 - generationVersion: 2.797.1 - releaseVersion: 10.0.0 - configChecksum: 701c0e56a0a6417ee5b67f5106f25ac2 + speakeasyVersion: 1.701.0 + generationVersion: 2.803.3 + releaseVersion: 10.0.1 + configChecksum: b2dc7cd5793412b3df69a7678603bcf4 repoURL: https://github.com/codatio/client-sdk-csharp.git repoSubDirectory: lending published: true persistentEdits: - generation_id: 26294436-7432-43bd-a9d7-1ab31c655c7a - pristine_commit_hash: b32b8c90d5ceb3e49bece1239b00f19e81679619 - pristine_tree_hash: f9acd2067a3a19f6823adb94a3b72c9450359ff7 + generation_id: 6b695a40-413a-40b5-8ab3-ab0acae8bfe4 + pristine_commit_hash: 7525ac9ce1881a12be38fa38c519252a7379ec51 + pristine_tree_hash: 8cd595122864616d251031d29d20748b3708004f features: csharp: additionalDependencies: 0.1.0 constsAndDefaults: 0.0.1 - core: 3.15.8 + core: 3.15.9 decimal: 0.1.0 deprecations: 2.81.2 examples: 2.81.6 @@ -49,2952 +49,2952 @@ trackedFiles: pristine_git_object: dd0fc763bd9548f5c8c2606f525bf5bee3b4feff Codat/Lending/AccountBalances.cs: id: 61a13e127407 - last_write_checksum: sha1:ba11c06a3e16b22486aeff54ebd17db6a6af06e9 - pristine_git_object: 3e5e178b3d6961ba844f3a91491d13992991445d + last_write_checksum: sha1:6d60cca902322595772889bab501c4ba6ac7a1b1 + pristine_git_object: ea8c7a40956030a20a4ee2cbffab9358a2241c59 Codat/Lending/AccountTransactions.cs: id: ec378eb222bb - last_write_checksum: sha1:ef3a3420f05fdae67812b6796efc2e2fe9a278a4 - pristine_git_object: ff63f6241fc4bb6cf13d1062a93e9019d28d09d6 + last_write_checksum: sha1:55d9f2dcc5759f2f084346ec7a6ec7fc85279633 + pristine_git_object: 68331c6e168fbdb893a1c9f4f4956b5af98e428b Codat/Lending/AccountingBankData.cs: id: f6180ea41391 - last_write_checksum: sha1:727a7305ba8e5f6391d7e04bb377729cfdcf2da5 - pristine_git_object: d9db9159b3ed377b860affa42058a019d42c2cce + last_write_checksum: sha1:37e0a264d0231728a0c3cc7591db7099cf2d4f27 + pristine_git_object: 1f29f351aa3c4b2ecd0d154b35c9ccf9b12b39ff Codat/Lending/Accounts.cs: id: 8b1ddea19c0e - last_write_checksum: sha1:e3c810528ea052c1493a271c6560cc8b4858a823 - pristine_git_object: 608234abf008478370b9d0b29063aa31d6eb6ea2 + last_write_checksum: sha1:dd4df98fbceabf839a66bfde1c3d15f9d20a20f9 + pristine_git_object: 2782c2d55fcfb012ae000d6728bec448aa120add Codat/Lending/AccountsPayable.cs: id: ac58fd4a5786 - last_write_checksum: sha1:c932b064ba3e57c679ca2350e1cd6badd178ed5a - pristine_git_object: e0b036df1dc8c88f2681689c78ccdc92ae8f6b87 + last_write_checksum: sha1:afd34ebc8906e910410d0f404fd785220b0d500e + pristine_git_object: 3a6da9a2e0daa3c5de326af34aec187e74f3af76 Codat/Lending/AccountsReceivable.cs: id: d1464ddb7d7d - last_write_checksum: sha1:790c5a0c4da101567df88628b9d0412c86eb0abd - pristine_git_object: 2ee169e8a0526eff903eb7e71fe6b64d953ace3e + last_write_checksum: sha1:b9f69e5a66ef9284d960d2e8361569d7e1d2743d + pristine_git_object: f84d462eb60cfec750ad6f26a888365ff743f454 Codat/Lending/BalanceSheet.cs: id: edd50f9219c6 - last_write_checksum: sha1:a8c91a673c8e654b561e172c0408b01cc61d5e11 - pristine_git_object: 726f68962099e17177569293b990a2a93cde2479 + last_write_checksum: sha1:69712d66aaa9fe2e374348d7d779ff8fcf2513f5 + pristine_git_object: 456650b6b550a7302aaefccdd10a294e855cf089 Codat/Lending/BankAccounts.cs: id: 758ebe6f36b1 - last_write_checksum: sha1:f4342cbc8669b1882bded8777faf06a411b46e13 - pristine_git_object: b55353c47885fea6c3abe7441560fa540d7c4d0f + last_write_checksum: sha1:e530eef21544bc79123738607ad35d91606abd60 + pristine_git_object: e3f348787f2c75686f8c06959d70a9577484fbfb Codat/Lending/BankStatements.cs: id: 3b460250a2a1 - last_write_checksum: sha1:69b274b03da77aadfb6ee188ccfe2acf0d1f562c - pristine_git_object: 1ee3da6622d1a6276ba651a9d4fa3159f2a2323c + last_write_checksum: sha1:b7e8d10fc97c6862bc281b6ebcc87b849efda711 + pristine_git_object: 398a465fad0797fc080d842ede8fed159623f176 Codat/Lending/BankTransactions.cs: id: 56875543d8d5 - last_write_checksum: sha1:c29f7ae53b9ad89dda1dea53bce522abcf147ed0 - pristine_git_object: 15d210045187f4a00575ef5d107b96e1c4feec99 + last_write_checksum: sha1:ff21a582e3c96d46665deb53a8469b6d1e178953 + pristine_git_object: 672375d998a8059c40deba9464b2a93dfbd16633 Codat/Lending/Banking.cs: id: dd0ee0faaac6 - last_write_checksum: sha1:7116eb792242a9f5d5c98e14e5b5f0d2663d7349 - pristine_git_object: d9aea9c6240bf1d97434b0fffba8b00c1a6ac899 + last_write_checksum: sha1:2fcdb97040c7628856b002122339aaad03f0a492 + pristine_git_object: b6e17d5ba348b10e1625d941b9df9f8916c56ddb Codat/Lending/BillCreditNotes.cs: id: 49ce0ab178b6 - last_write_checksum: sha1:19926c86b8988e7879d683d56bfcaaf215acb700 - pristine_git_object: 3e13707de93c82417c38b072d47b5c3669900ac8 + last_write_checksum: sha1:a322285a1cd7eb880ace72ac9c6f5b2e5945a1b6 + pristine_git_object: d85dbc4b6aba3501ede38e023d5849baccb47f16 Codat/Lending/BillPayments.cs: id: e750780e6199 - last_write_checksum: sha1:2d93dd941878b72b805cb92cbbea84deba7354a2 - pristine_git_object: 33585f9e79b750a2f8583912a32da48954b6842c + last_write_checksum: sha1:d777c13dded30041689984836ebd833b246fa8a4 + pristine_git_object: 80446e5aeab59f39f5a00f16d09c8126d1b67bcd Codat/Lending/Bills.cs: id: 051e1bdbec0a - last_write_checksum: sha1:157d7bb06cc884b51e7b90c52b05c0c07fc8819f - pristine_git_object: 0cd108c02617f5ab640307e34611092f8ffde7b3 + last_write_checksum: sha1:1102aedbb0b391e9f037b4ab5a89058541305704 + pristine_git_object: 235484273523ebe276591b57fcd09bf7abe72d80 Codat/Lending/CashFlow.cs: id: e3d8574d52fd - last_write_checksum: sha1:4a11c1b550857e1496d32490837c3e94548bc9b5 - pristine_git_object: 493b7abe56f6609aa9e9aa5e8e6021c2c1a70d54 + last_write_checksum: sha1:471756424d0776628ed309fe5193fcba202b8cf2 + pristine_git_object: e43b8e3b5b8fd7cce64cf7bce23cc8f097587da9 Codat/Lending/CategorizedStatement.cs: id: 0a3bd0e30e3c - last_write_checksum: sha1:74689c6968c7659ebb64bad20d21e88c51d8c26d - pristine_git_object: 2c3736e65e6a04137962328a624c3a1807d18aa4 + last_write_checksum: sha1:f34ff4e188594c1c9d4db9e573c51315de85335d + pristine_git_object: b4be1965ec1334191b621075e508e6ba5f6f35ce Codat/Lending/Codat.Lending.csproj: id: 0d0ff25563e3 - last_write_checksum: sha1:560273cf3f21e1c5fdddd5a8ed4e53366b252815 - pristine_git_object: 1d6da12ab8eb71a8af5437c76fca2bc51e5885a0 + last_write_checksum: sha1:ffededdea115cbffa627603b064068476dd529e9 + pristine_git_object: c88d46496f6ae966eb008b48af78d066d4e3b263 Codat/Lending/CodatLending.cs: id: 0cd451e759dc - last_write_checksum: sha1:2242177cc1f42a91f7161c48739eaf9bb66f44ad - pristine_git_object: 9d53300bd7c9703b2c6e32fb7c66001bed704f48 + last_write_checksum: sha1:6a551d54c5e7127214725bbeb4131bdecb7d269b + pristine_git_object: c91360b0c6ffc014a1b024b8fd69fc2a7d0a25b9 Codat/Lending/CodatLendingAccounts.cs: id: 69b6dbc92708 - last_write_checksum: sha1:796d762b59e77f04fcde32d0b5feff1613fb7296 - pristine_git_object: 76f84a412a8ebc9c0264ebdeecfc325f207f04f9 + last_write_checksum: sha1:e2e5cbd26a05e7bb363d4dac59e61ccf550c6de9 + pristine_git_object: bb5ca19a1c442fc14bb498a4a191dcdf161be798 Codat/Lending/CodatLendingBankingAccounts.cs: id: 4e2a13f18dcd - last_write_checksum: sha1:c3d95144b5865addd306103b66fa54a477e38980 - pristine_git_object: 39e11740963ac858f203f608e43d90d1a49bac56 + last_write_checksum: sha1:6b0f86ff92b5da8afca505d55c73851c47435efa + pristine_git_object: d8b41658e53dab49f5bd8c2a5219eae12fabf86c Codat/Lending/CodatLendingCustomers.cs: id: 62623e0a444f - last_write_checksum: sha1:15713bccd5469c9ba6a8326e58b137728631ea6f - pristine_git_object: 812243295a0c42a694680687762f4fc4e10cba8a + last_write_checksum: sha1:c4e602462f45cdb01f967b4fff054fa72d771b88 + pristine_git_object: c10743767cb797409ab825de881c4e765e5d7223 Codat/Lending/CodatLendingDirectCosts.cs: id: 29b43364b2d5 - last_write_checksum: sha1:6754afaa2346fd308eca4a9022681a281303fa50 - pristine_git_object: ad23f4e93f539fc3ff1ced4a436fc8c5426ce151 + last_write_checksum: sha1:a54edc5910fc6e9f28899c8e9daf4906f4ade478 + pristine_git_object: 77998db8176a062c23526970a1319af946e31b29 Codat/Lending/CodatLendingLoanWritebackAccounts.cs: id: 05e59742aff7 - last_write_checksum: sha1:bc3a49a7065179fc0dc468056140f2a1c3273436 - pristine_git_object: d518deb6ce3acfff7d73b7f18310fdfe8ebb302f + last_write_checksum: sha1:19a37acc3799e86b1ab06f5fd9c3de6e54c46e21 + pristine_git_object: 2ee069d7cba4b97845c79b5618e2b8a72342dffb Codat/Lending/CodatLendingLoanWritebackPayments.cs: id: e4a3ae7f7dd4 - last_write_checksum: sha1:57a617c4eccbfd5646788e5742e241f9327c5c48 - pristine_git_object: eaca9143227713b013e238230ce55cd8edc1447f + last_write_checksum: sha1:c5a9dbcff3c5d40dffe748c463033708e189ec4b + pristine_git_object: d920ee12b3e395372a2b4dbbf36be356f01c766b Codat/Lending/CodatLendingPayments.cs: id: 25eba761f532 - last_write_checksum: sha1:bd9fc7444186627c25b314106f7478a9ed74c14f - pristine_git_object: 9535ec50f1dcc9575ad83a28f30e17a7eda21c72 + last_write_checksum: sha1:c2c613eb0e0848ada3cf7a38e557581273dea8f8 + pristine_git_object: 93480b4bb21c2bf430702c486209a49153157a3e Codat/Lending/CodatLendingReports.cs: id: 3156dbae9e30 - last_write_checksum: sha1:6de727f9d13c6d014a76cc4071969dd0d90e6615 - pristine_git_object: d08c38c7c12b4f0de16043f1e467bea31187a680 + last_write_checksum: sha1:6e658011ab5724f62239d5fcb2b24d47b87b93f9 + pristine_git_object: 4b242d0426b8216a7159bbdce332cd22bf6acfd7 Codat/Lending/CodatLendingSalesTransactions.cs: id: f718594b3b96 - last_write_checksum: sha1:23c66665d0e4d45de74ab691ef44d7cb8c7b705e - pristine_git_object: cb4492033fc97f1cba7e9e5da4a351c59082c12f + last_write_checksum: sha1:5b7a31779dad7f146ad5496c9dbf3f2f150bdda8 + pristine_git_object: 79c5c493b24c0452a8eac349d81a36ca0b106ba8 Codat/Lending/CodatLendingSuppliers.cs: id: 000de83a7d04 - last_write_checksum: sha1:abdebbda585b0ea10456e6503f836b76aa7a420e - pristine_git_object: 5101d386378e8dfa425d8c9f1108130d1ce576e1 + last_write_checksum: sha1:6d4e4dae4c2597014ca232ec8e5ba13fb7386b65 + pristine_git_object: 38888f78097503d9a1a83f07e1c204689ccfdd94 Codat/Lending/CodatLendingTransactions.cs: id: 48a61364024d - last_write_checksum: sha1:4aa474a0cff4dc3a3a93ab1acdfe023a7b045f7a - pristine_git_object: 0f8069bde3bc32d9fa69045ab26190bd25eca41b + last_write_checksum: sha1:1b9cbb04c5c8559535fd5cdd7db4befe979c16b4 + pristine_git_object: 36ea629c4ca5e25d14d5f4cdbce7438046425b5a Codat/Lending/CodatLendingTransfers.cs: id: 44b6e8986525 - last_write_checksum: sha1:578a02b3690752bca30e54356a9d6b64a51067c6 - pristine_git_object: 8ba70d183af8f6861504038e1754db577347b8ed + last_write_checksum: sha1:067fa51c6915c5f3f98bafc4142bf9445aa1a2c9 + pristine_git_object: a00d2977b9d1513eb20fe6448f2cfcbffe059e14 Codat/Lending/Companies.cs: id: aa390ab32eef - last_write_checksum: sha1:cef97bf22ebc3f58e544662fa370e18fdc2d5571 - pristine_git_object: 5ac024f14355b355930abe81522cd258001af2f4 + last_write_checksum: sha1:b2825fa7c888bcd833b7b41f22b15fc0560da55f + pristine_git_object: 324feedc78542ff5164dca37f061d67f843c86fe Codat/Lending/CompanyInfo.cs: id: 10e3edcabee3 - last_write_checksum: sha1:3b4379fc6d650c097ef6588b412cbc6bf896f6fc - pristine_git_object: 6c395746bfe4b87cf679f6003a3e624a15136764 + last_write_checksum: sha1:3446a9dcc942b828cab6aa8b92bb137514887038 + pristine_git_object: 118828ffe672fb80b124434624addbb6a715d7c6 Codat/Lending/Connections.cs: id: c02484f8a3a8 - last_write_checksum: sha1:d2e5ecdab6ede2cc7a6cc9a39df80f38d70db104 - pristine_git_object: c8a5e8d281dbf6010dc368096fdfc0f6ac209d65 + last_write_checksum: sha1:5f4efe49f0ce28dea7750bb604995e4676790091 + pristine_git_object: a9e94918b4a204c46457ef688520b7f3ba94452c Codat/Lending/CreateOperations.cs: id: 8f6b71a4062e - last_write_checksum: sha1:bb78775bc2ec28a71a42fda3571ec6cb98e220ef - pristine_git_object: ff9f84317ae1f93ba12ae10c25fe4f7913ba1ccd + last_write_checksum: sha1:ebe14e774145fbabc1e43c89659773eb9186122b + pristine_git_object: 04b9befd4adb69d03a63f488f275866a61e6694a Codat/Lending/CreditNotes.cs: id: 2ec2bda4f2d7 - last_write_checksum: sha1:34fa58f2e437655c457ec820095b1185857899dd - pristine_git_object: f4df11c01701adfd5e6a1c75caee62844d80f8a2 + last_write_checksum: sha1:46e9efdb3bc36fcb9eff57c53d4b32bf2ea141c5 + pristine_git_object: 82d53cfbed8b69e09a9aa5035681e2f6dfd3166f Codat/Lending/Customers.cs: id: 37084fde8854 - last_write_checksum: sha1:3094c9ba21b355e0e4c85dd2e15bc810f9264ffd - pristine_git_object: 230dec1269657ef79b95f3308577d16f390785ca + last_write_checksum: sha1:b35cda27e5d4aeefafbdf8ce9cdd1b2111e3df3b + pristine_git_object: 506a16ba2d2c72ee17af9ff314f132b8d529595f Codat/Lending/DataIntegrity.cs: id: ace899aba277 - last_write_checksum: sha1:045036484ed5bf65d1953c1b90872e2861843372 - pristine_git_object: b9d11b7d7f7e01f9e5c8c9afb745f8067435b4cd + last_write_checksum: sha1:72c472ca02788f53c5bf8273c8ba6482f5206038 + pristine_git_object: 80641bbda388656602267ada3e51b72656b1528e Codat/Lending/DirectCosts.cs: id: 9174cacd2644 - last_write_checksum: sha1:9daa9ee0cc421013bb12fa3088cb3671aff41858 - pristine_git_object: 9f9701bfc789d48ece4de86975042bf58627e6f0 + last_write_checksum: sha1:477030b99c4952dda85e0b6af0007c7388fa1a1a + pristine_git_object: ed0abc024104161df594ccb1fce99850f09b6d58 Codat/Lending/DirectIncomes.cs: id: 6afdd2b31623 - last_write_checksum: sha1:c667f4d21cc6c40e219e9f5d55c56ede7e5ab6d4 - pristine_git_object: 75f36c2acf24f1208b38f1c02bea5306ec516502 + last_write_checksum: sha1:cfcadd63163fd3d76100e5a172006a6a691efc7a + pristine_git_object: d543291d6fc27bf94a072f4ceb7585720ffc6803 Codat/Lending/Disputes.cs: id: 09385a911974 - last_write_checksum: sha1:b24b87fe1edc48d002fab154dabab6e588dc58bf - pristine_git_object: 451a276ba957f19430c1afa533e0287e0cc32519 + last_write_checksum: sha1:57b50829c5c9f03089f38e6979fbd84c6668a2c7 + pristine_git_object: c7827ced0c9638d23abe968245ac3699f93ce63d Codat/Lending/ExcelReports.cs: id: 569b49a9d3ce - last_write_checksum: sha1:eb70c00302e4c89fa3cf9a954a40dfa9ab4839b6 - pristine_git_object: 90e33757924e0cdd046185d79aa2e8406e110c41 + last_write_checksum: sha1:73fd46c83f7016a6a29910944bb4065e3ddf1969 + pristine_git_object: 332de610bb73fd12cce830370cb03570f75cd0bf Codat/Lending/FileUpload.cs: id: 8cdfb9881ce9 - last_write_checksum: sha1:281ea36fac1f5369e91efb14c2bc9dac43ac20d2 - pristine_git_object: 0156718cb645ac4f915de6c5123de268aa017029 + last_write_checksum: sha1:c74385134f3ef0bbf72c1e6ba7b00bba0858deb2 + pristine_git_object: 47efe95b012cdf7b02ba1c806dbfdd629c75ea76 Codat/Lending/FinancialStatements.cs: id: 6be629ea2964 - last_write_checksum: sha1:ce1361494199e1deacaa36953b215b5958f07ae8 - pristine_git_object: f9fee603bee877d7304ad1d8b528fa6ce4b6fd03 + last_write_checksum: sha1:56250301a0d14200a735ff987e515ed529ec5431 + pristine_git_object: 1f06868cbd13b23cfadc2523e5e480d0657a43a2 Codat/Lending/Hooks/HookTypes.cs: id: e5f5508c6e14 - last_write_checksum: sha1:1378ee2d2329555472ab091badf2b754823ec220 - pristine_git_object: 13985d1a3d7c5cf2776be52707641d0621154290 + last_write_checksum: sha1:30e4f173364bdd5a622a30a19b697c685714e15d + pristine_git_object: edec6401476cc6b5885801aafbab8e52e68faeb8 Codat/Lending/Hooks/SDKHooks.cs: id: ee9be54a8166 - last_write_checksum: sha1:84e98f2264e1907c4c1f315be8cb4138bc78d814 - pristine_git_object: 7b15536c6ac3188e57d2f7783ef43e4b2c282a8a + last_write_checksum: sha1:f4cc5fbf8db81a81832628a16b0ea5791cd5c120 + pristine_git_object: dc90041b82e932bf04bd771ffb5d7bec4b6e36af Codat/Lending/Invoices.cs: id: c33b167a8df1 - last_write_checksum: sha1:2f8d14ccda2937fca6301eae5f6e67ade67c99fd - pristine_git_object: 2b66293520e551fec7d706b7e0a0ea9e3458d731 + last_write_checksum: sha1:29ef2410207e5320046da10193103e15b0856092 + pristine_git_object: 9cda2c8ad13f65565f512b7e75c2090825056009 Codat/Lending/JournalEntries.cs: id: 21a85e4bb52f - last_write_checksum: sha1:a2edfd62d09b707900b75d35f5d7011d20364d65 - pristine_git_object: 6ad58f5c4fc0dc4f46223ae7abc7451be4ad165f + last_write_checksum: sha1:e6f88832148cda10014916a78876f7af070ace6d + pristine_git_object: c5739e7118eccfaacea416ea1aa3a3308cd7c5a8 Codat/Lending/Journals.cs: id: d9e245de93fe - last_write_checksum: sha1:c386ec429db602c5b7fd165942e9bda15cd5afee - pristine_git_object: 7e31998d8df3a0337415a37579dd4517615f5153 + last_write_checksum: sha1:511d8e8295f29d84ff9ba51476995e7b715ab80f + pristine_git_object: 20a2e75626020c987a6a6e3a157cb1b97408b54f Codat/Lending/Liabilities.cs: id: 66c801b11294 - last_write_checksum: sha1:b1f1c5b87c944e449a0e90c8cf4283b8cfa8905c - pristine_git_object: 0aeebed6792f5addc18ad1070b219e14b30f43ae + last_write_checksum: sha1:0312c088129adcdfde89558a3e4c2ee4e93187ea + pristine_git_object: 1766819e4248cef54e22b0bd091df45fb49f8a4b Codat/Lending/LoanWriteback.cs: id: 973d271f91fc - last_write_checksum: sha1:3f7693158146ce7229678f7400bf1837b170043c - pristine_git_object: 78251f9c78879acaa8ed5bd1266dafe268ea02ff + last_write_checksum: sha1:a646c5de963b913b14e70c0df066833c3e02637d + pristine_git_object: 11c3658e5095cc1d3c9670c80ca67f8e98070f6b Codat/Lending/Locations.cs: id: d52deed38107 - last_write_checksum: sha1:e825678699dadda62d4532e7db72779dbcb4fb2f - pristine_git_object: 7250706662f8c53780cda1033b112c77cd934adb + last_write_checksum: sha1:7d4348bf0f7607a0906f12f35d571ca53424dd66 + pristine_git_object: 684ded218d1312c08d1bbdcdf2c952a3628b5250 Codat/Lending/ManageData.cs: id: 75b953997d4a - last_write_checksum: sha1:978476ed0b82c556776e761ee374d43b2f9b1060 - pristine_git_object: 7af71723b674bff1d5de7b13fd34b31cd0661cc4 + last_write_checksum: sha1:f9076a23e282c327f257cddb31a5d885026e3c37 + pristine_git_object: 80fbda9dcc39ecfb56f65e0c06d77b1edeb43ef5 Codat/Lending/ManageReports.cs: id: bfa11f6bbb9f - last_write_checksum: sha1:01b55f589336b6f8c03b037a5c0fcfef128613d4 - pristine_git_object: 182102d74202fdbaf794634b92ef4efa2181decf + last_write_checksum: sha1:1c70c070e5a8ba6403154827b245e175ca5c09e7 + pristine_git_object: 511a60dc53b6c113a8130d1c4d6a9a8a449fab09 Codat/Lending/Metrics.cs: id: 3c2a34c8194e - last_write_checksum: sha1:9b803f194e130afb7f0cca67ad03cf71269dbbba - pristine_git_object: caebc9d1bcb62a73c2eb58e03b75815a62261979 + last_write_checksum: sha1:b587813ac4d104250aae0ac00e38e9a599592ed5 + pristine_git_object: ab2bd601b01b9efcc0288ea2b5c190e858b4e44b Codat/Lending/Models/Components/AccountBalance.cs: id: 161b936a0702 - last_write_checksum: sha1:ed0d0e268818c79d3c3299598c7ae215cc7c0fff - pristine_git_object: 7fd3cdaae7a7b156bac3d69ab287bc80b9448219 + last_write_checksum: sha1:9f0fa4b9c1b0ed54c6db1a2c1b5084ef021de3cd + pristine_git_object: dc9b72c76848bd0e801155943d305e7e45251140 Codat/Lending/Models/Components/AccountBalanceAmounts.cs: id: 1d12c55fac36 - last_write_checksum: sha1:6ba8ae4531f0387181be43f5736423943d308a56 - pristine_git_object: 77fc4692d7e2229f44cbac4009811207e5b334ea + last_write_checksum: sha1:ffd2bc4933d653ac541ac739e3a5bb17945e9cc0 + pristine_git_object: 09bc4acb545b0d9f28b7382d749dffee6a654ce0 Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhook.cs: id: 0cb5dd0961ec - last_write_checksum: sha1:125d3b681f23dbab6aa1e713c5a7a989b0712672 - pristine_git_object: 32620590843c708e1f7bb2aa6c63476c408b472f + last_write_checksum: sha1:45ce36fd87cc831a5cd9d37da33f71c62c19962f + pristine_git_object: 139e97c9a98f605094a781e3021487536c55aa1b Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhookData.cs: id: 836ca1469797 - last_write_checksum: sha1:6148bb13ed801c6addd5b8e6fa87b79831581157 - pristine_git_object: 3b764b482db78cad469c8401b18d17902cf791b6 + last_write_checksum: sha1:38232bc06cc0f18b3a19ccfccf395137b4525fa3 + pristine_git_object: 13b47ad0812c2491b7a62cefb7293e0ceb2cba23 Codat/Lending/Models/Components/AccountCategoryLevel.cs: id: 80b5f2499a2a - last_write_checksum: sha1:4deb4c2347ae32287a595e421535a4e093626ae6 - pristine_git_object: 8f20f907566a6290c4bb97065e1a81298d0f14c4 + last_write_checksum: sha1:bc82cc92674d3e423e89d115145f8434a53f616c + pristine_git_object: f693d9d9a69d1de1914a2ab6d3a98d979e1e4adf Codat/Lending/Models/Components/AccountIdentifierType.cs: id: a64ca6a83a26 - last_write_checksum: sha1:16a075f276a262eb8693ab9cad115370b2aebecb - pristine_git_object: 0d35435ce3b88a9af0c83b1cfe8dd23a25c28689 + last_write_checksum: sha1:a9b2354223988dfc09fdaf3abb71aa376ebc22d7 + pristine_git_object: 6b00efe7ab73444dcea0cbc14fee4c87047e7c1f Codat/Lending/Models/Components/AccountIdentifiers.cs: id: 15866e89bee1 - last_write_checksum: sha1:b2d0dd75c986b0c622eb31e0a90caeae898aacfb - pristine_git_object: 953f0840a93e5d18ba2fca97a32a53da0b70557f + last_write_checksum: sha1:d28b620348d256eca075414d20bcc13b42680ecd + pristine_git_object: a8852d4babd3f28109f67ba36e605bb7c192f5c1 Codat/Lending/Models/Components/AccountInfo.cs: id: e5cf75ef7124 - last_write_checksum: sha1:e05428dfd91a87851fb59aee431aa41a644f130c - pristine_git_object: 4f315186744e20e723a020dc4ca25031d10b8ae7 + last_write_checksum: sha1:3a33058009ff6180b83128b408d538b60399e639 + pristine_git_object: 04c1819463adf6f5d0ab6931e7cee795c4490bd2 Codat/Lending/Models/Components/AccountInstitution.cs: id: e61f0eaae89a - last_write_checksum: sha1:57275f3dada6d72038ddfeee24e80b85bbf75493 - pristine_git_object: 315674eac88729b9771e0a73c3a9bcf4f966f278 + last_write_checksum: sha1:991def00069f9d80bbbb3f5a243d7178ec13698c + pristine_git_object: 1c84e13a82fdc6befb7c9d9746c66eac140c53df Codat/Lending/Models/Components/AccountPrototype.cs: id: 9be587afc7d3 - last_write_checksum: sha1:94ec6fd90608f95b05f5b66596352ffd0613d6b1 - pristine_git_object: 14abe33e7105a1c11c639513cc9bc03210a9a446 + last_write_checksum: sha1:22169265389c49dbb14086564aeecc323c23eb30 + pristine_git_object: c57cbd9b2810efaf8191c3ace7fee4622756dda7 Codat/Lending/Models/Components/AccountPrototypeValidDataTypeLinks.cs: id: f4617e37f3e7 - last_write_checksum: sha1:c5b77df3f1729eccb23be2f6d50adf1eacfd615c - pristine_git_object: 1bb4cf9d0ca1ce786760e40f54186a84e430ead5 + last_write_checksum: sha1:8b33be9e151f3e39ac7d13ccacb63b3ae8f885e6 + pristine_git_object: 497e1bf845090c75cc2da2d046ca61cad159369a Codat/Lending/Models/Components/AccountRef.cs: id: 5974bf30ecd2 - last_write_checksum: sha1:c680a90e13f62aa25526f85fd3aa1a0a2649ab96 - pristine_git_object: e738be8eeca115a1a82e1828f68e73fcf41670a9 + last_write_checksum: sha1:8fd3c65d3fc559cbd3652659ed345f38e74cb75d + pristine_git_object: 643f462693700c75f7ff4ea0de8ca0ec0631e806 Codat/Lending/Models/Components/AccountStatus.cs: id: e94c00fa490b - last_write_checksum: sha1:eb4b3b1a87798e82be65f62b7c1602ba118ac81d - pristine_git_object: fee604ffadbbe446206db111b6ae153d86bc7c3b + last_write_checksum: sha1:3ee1234350fef4b2c193b04875531f4bee31f9f7 + pristine_git_object: ec354bad594553fb7845c34aec8a9c4b1af5ab39 Codat/Lending/Models/Components/AccountTransactionLine.cs: id: 1bf2cc743cb7 - last_write_checksum: sha1:e5eb43667e0e5ced4314cbaa1c05d3ee962b2598 - pristine_git_object: 4492fbcb0200c4e993b495b5006d092536316aa1 + last_write_checksum: sha1:26146bba525424c8cbb77420387a2f4120070f52 + pristine_git_object: 41ec83a6e92baca2715c28e3fd301209f06baaec Codat/Lending/Models/Components/AccountTransactionLineRecordRef.cs: id: d2de8eba4ea9 - last_write_checksum: sha1:67a898e5ec5f020898f3a6f740c9ba60b37a8d90 - pristine_git_object: 5fbfacd23e9d7f8ecc8668cc26bb40d16ce10566 + last_write_checksum: sha1:75ab57177be71f9d4f5516dd18354d6efce53802 + pristine_git_object: c19802e08d84640f11e186a56787be113104abec Codat/Lending/Models/Components/AccountTransactionLineRecordRefDataType.cs: id: 9e92b5023c3f - last_write_checksum: sha1:43a60c7cd914987fe24d2ae12ff1599e393931e9 - pristine_git_object: 4622e29a77c70c807803111334da08f41adbee26 + last_write_checksum: sha1:3d4447a47581e93d39379c5363f6aacdd7a06bcb + pristine_git_object: 6a50280a2b4555f46a28ba14d37cf2372a4d8e24 Codat/Lending/Models/Components/AccountType.cs: id: d1c0c5afc063 - last_write_checksum: sha1:031a67b4fc388cb979526b598d5f553f35435494 - pristine_git_object: f99f4599e820a2744e5ef984d8b9e8c6ff534b33 + last_write_checksum: sha1:1ba794d29c844200fc50c552e21a2f2e03806fee + pristine_git_object: 9cfe09fb126c6bb610250b5ebae43ac07565da7a Codat/Lending/Models/Components/AccountingAccount.cs: id: 3d27895e0b1f - last_write_checksum: sha1:8f852b9450c4224381d50a4573e4221b046414d6 - pristine_git_object: 098d7e0730ace2aefcf9bcf8fc0f63fcd52afb91 + last_write_checksum: sha1:200fcd9e43e0eebeeee321e8ab140d13eed12017 + pristine_git_object: 92ba55642be66772be4c4facc789a4dac7290124 Codat/Lending/Models/Components/AccountingAccountTransaction.cs: id: bdff40d5f689 - last_write_checksum: sha1:c39fb9a32a57f27c342121c600ee14c56769cdc2 - pristine_git_object: a1d7d29cc8d48d174df67db9deb18d314b327654 + last_write_checksum: sha1:36751cbc295374556b3a9132c12294b773858f2e + pristine_git_object: 568cad4f4a1a3d389c78597abea57ae406b38780 Codat/Lending/Models/Components/AccountingAccountTransactionStatus.cs: id: f82cb4776b38 - last_write_checksum: sha1:2d894a41f7adf16f97cfb30f583a8b05b44be698 - pristine_git_object: d7877c82f445f8f94a406bd3f53b809b05e1927f + last_write_checksum: sha1:cefb19cde07649898d1ac00e5fd6bd43c53935ef + pristine_git_object: 0d404e4498fb276d1a69749faf41f96298dbfe08 Codat/Lending/Models/Components/AccountingAccountTransactions.cs: id: cca23e7dfe9b - last_write_checksum: sha1:8ad2d1c7c8e1977f8d44de80235e827d0b72b42a - pristine_git_object: 1cb79722b3bc6e3c3d813e93846a927fbf12d6b8 + last_write_checksum: sha1:f793d91cf17c433a07ce69904f12cc39f2f8ca32 + pristine_git_object: 3019c4e8418397d4a6214b3d09ba839bcd3e7f9d Codat/Lending/Models/Components/AccountingAccounts.cs: id: 54e0dcaa725a - last_write_checksum: sha1:3ede5d21837ab157d287cd6297e4cf1b752be508 - pristine_git_object: 11fb6f46a9a8f1deae2e102316f27938b3941681 + last_write_checksum: sha1:c0527a4faac0b489fb2166be10f0167582ce1688 + pristine_git_object: e1b8e6116c82442e910d25e256320b9552614729 Codat/Lending/Models/Components/AccountingAddress.cs: id: 2efb479d0361 - last_write_checksum: sha1:b221ff00bba1e040e5cae528267a001edc687e48 - pristine_git_object: 181310d56b40047d7c6b72eb263b55f7bba19171 + last_write_checksum: sha1:9b5321a90e284512680a8b9ee90bc7e5a3566c29 + pristine_git_object: 23b11ee58fa803e6921f2415c4619a2c71ecf46b Codat/Lending/Models/Components/AccountingAddressType.cs: id: 6652d010ee1e - last_write_checksum: sha1:b8e4d18f0be1d728064239ceed8a49cefe3fc172 - pristine_git_object: 5a9b76e284e3a0cd6f4c0903192ab514b8da7786 + last_write_checksum: sha1:e3a04fe34ec3f5c702237624a57f1aa0f1ac9fde + pristine_git_object: 7705dcf72ac5b5e331cb9e71fab618a3b1a50ada Codat/Lending/Models/Components/AccountingAgedCreditorReport.cs: id: 072a5745eda8 - last_write_checksum: sha1:b89faf07b8000dd9f3682a6299c054b62226935d - pristine_git_object: d3b2cd1773abd89b0ef316aacc046c331150041f + last_write_checksum: sha1:ef18ba330387795f7d1bc8424ff891fc4bc9514b + pristine_git_object: 6f13ed8daa125da9df0d3df1be5ac65be3337a18 Codat/Lending/Models/Components/AccountingAgedDebtorReport.cs: id: 45e4b0d8e015 - last_write_checksum: sha1:13fcc91af3ef819029a24c4ce6d1953363c15c56 - pristine_git_object: a99b22bc7de9b7f5ee3db1f68bea87b70cfc9cf5 + last_write_checksum: sha1:6949a5f91d473521f8cf95f5995e6789e443d69c + pristine_git_object: 62cab41e14e07e2cf41c697e27ebe9a494226f5c Codat/Lending/Models/Components/AccountingAttachment.cs: id: a4a29b16dffa - last_write_checksum: sha1:f84e6184cf8d0dfdeb48836f426a6d484367ec60 - pristine_git_object: b386fafd0525e7f72fa03b0bdbe256024d22be16 + last_write_checksum: sha1:db0d26cc13ddbf21d06a06aff52f5be3899ecc06 + pristine_git_object: 306ca7510398bf7596e7d8d597b62bd799dd2d1e Codat/Lending/Models/Components/AccountingBalanceSheet.cs: id: 31470beb015d - last_write_checksum: sha1:e65163617a2e2e0b7bfd8874fff9e31affdf8693 - pristine_git_object: 4fb0c320af78b22b32482f101ad312289cd4019c + last_write_checksum: sha1:65d94be5c8b96952c2877688304effd5be1b41be + pristine_git_object: 29bfdb93859b758d23d53d2898a8087afcbc30a5 Codat/Lending/Models/Components/AccountingBankAccount.cs: id: 8af181948ecf - last_write_checksum: sha1:1752a941db76461a8760d68e6fcd6fe4086d1570 - pristine_git_object: 4ff78e480aad0126fbd356bb3673df08e4a64908 + last_write_checksum: sha1:f05acf9539e9f2d3647cfeab214b78ab1128b44c + pristine_git_object: abb9ad2e89eaa6931946ee7cbe04d0e770d22d79 Codat/Lending/Models/Components/AccountingBankAccountType.cs: id: ff85c0b6dee6 - last_write_checksum: sha1:2c2b36ad725ab1e3387fea254c1153970ddd80f0 - pristine_git_object: b6a3c5c0f467d1b9ad4f2b9cacf326289af97f1e + last_write_checksum: sha1:9bf1fb739cb8e308f61205ae2af8aac3913dc8b0 + pristine_git_object: ed6f68f4b43465590c0209e317abb31e1a873f55 Codat/Lending/Models/Components/AccountingBankAccounts.cs: id: 6520533e3948 - last_write_checksum: sha1:ec96e190f09560f4d879f3d8693419400ca0caa6 - pristine_git_object: 0f0797917eab822e3e9552d6147618a8df5e78f9 + last_write_checksum: sha1:aa14dd67d55034eb0279b9309f4eac98ddb4c741 + pristine_git_object: 5b687a8b4c80e18be36a56efaead68932396da8d Codat/Lending/Models/Components/AccountingBankTransaction.cs: id: ed617ce70671 - last_write_checksum: sha1:b05e5716006b26a9a6ae416f22aa19b71ae2644b - pristine_git_object: 0195c3df7bf44494c27b1d001b39a2cb2750fd67 + last_write_checksum: sha1:359253712f2b239dc1c7d9422bf3999c7df4148f + pristine_git_object: 8e98119a07ec7105812d69e84e460a6dc2df094b Codat/Lending/Models/Components/AccountingBankTransactions.cs: id: 0e3583a07c8f - last_write_checksum: sha1:be44874f23cd2661c6f7042ba8a4686b5adc52ab - pristine_git_object: 996b1911710b97668e716dc8050b731c40169c31 + last_write_checksum: sha1:fbe3bf0e64e71fbb50b80b079931ec9cabd881e7 + pristine_git_object: 78253a2884dfe7db0b731d985749fe187d691974 Codat/Lending/Models/Components/AccountingBill.cs: id: eebb53d2e0a7 - last_write_checksum: sha1:de5b14f7a3a4dd0b869a6c7611c3c32e367b3a90 - pristine_git_object: 45acb0806b6d1d651b8df27cdd695c54ff85ceb7 + last_write_checksum: sha1:bf7c3cb6bd5ab80e378836d71af27209af3bb0f4 + pristine_git_object: dd4f452566b9d9001ac6a8dbba885e960ec17583 Codat/Lending/Models/Components/AccountingBillCreditNote.cs: id: 1bc5b28ca5aa - last_write_checksum: sha1:fefe53442f24d0880275376bd40ae98dd14d7087 - pristine_git_object: 494115c86f845564fe64b43259635faefa1e2cd7 + last_write_checksum: sha1:ba7e961b46d3608d6dcb607fe2a30e539285dab0 + pristine_git_object: bc650d6edd1ddb079625f4f2cee612fe0185e687 Codat/Lending/Models/Components/AccountingBillCreditNotes.cs: id: 77bf7da6830d - last_write_checksum: sha1:70e3bd82e1a43525d880e93e7ef95735aa849486 - pristine_git_object: eeb50d519c86a049823e4f2a9ec1ae1d0aaee29f + last_write_checksum: sha1:f2bdd2deae631c6e7c48246af8c04255ea45987b + pristine_git_object: 7726dcb050346c75ad658f255238ba38506b0bf6 Codat/Lending/Models/Components/AccountingBillPayment.cs: id: 64f5e46bb152 - last_write_checksum: sha1:20ea3b17948214dfe3fe0beadfa3b5d4997c9512 - pristine_git_object: c5e9aaf88c07477f7d5829a37953ad19ddd8e7b9 + last_write_checksum: sha1:def84ed106b31f66be81dc619fc1a0e3d61da5c6 + pristine_git_object: 6671864aad6fac85c72a4dc4b43b5c1d24233f23 Codat/Lending/Models/Components/AccountingBillPayments.cs: id: 125b086fe0ee - last_write_checksum: sha1:f5dc2de11cc330ed948764ff371a335df4e63f30 - pristine_git_object: 2f389e372ea5b1b9f88effa6d0178e01d12b0d30 + last_write_checksum: sha1:4782efab748fd54e88a6db59543e762ef8940ee0 + pristine_git_object: bd3b2f4fb70370ff34497d6e821b0ea8a2a4c4ec Codat/Lending/Models/Components/AccountingBills.cs: id: 1651b15e0d71 - last_write_checksum: sha1:66fb35ac8f6d28d158a44692dcf6f7d014209350 - pristine_git_object: 01c9247e66d129b0f85da4fb7fa111b208a4c47f + last_write_checksum: sha1:ee43cdabc056b92d1ffc707bd3697027465fd96a + pristine_git_object: 94434d98371b120e9a12e93db502258d965fdc9b Codat/Lending/Models/Components/AccountingCashFlowStatement.cs: id: 7e834afc0cd4 - last_write_checksum: sha1:018917e864f144536edf0d232a9927dc0616036b - pristine_git_object: 270c183cb0b29f8006c95207c1fd8e3f5512c615 + last_write_checksum: sha1:ba4fad3034b12732f1155a8e54ab1cdcf7698d09 + pristine_git_object: bdefa0cc9d3c142c420d4c424016d79b0d611ddb Codat/Lending/Models/Components/AccountingCompanyInfo.cs: id: 655d5714531d - last_write_checksum: sha1:3fbbdbc88063b37fc4358677f2cff535979c798e - pristine_git_object: b2f297ba608941decc076bb9e8dec30a26142952 + last_write_checksum: sha1:3666d63efb65915e406c3128e7bb0cde00fe9364 + pristine_git_object: 415d6ffcc6985b6a14bc3c6abd2c61041439cb9b Codat/Lending/Models/Components/AccountingCreateAccountResponse.cs: id: a3176ffe8ec0 - last_write_checksum: sha1:7248a5ff10074da67dd94aebffee2b07a6ddc592 - pristine_git_object: 40afe3c42a5508124b0f4a066a0d51ab2a53e3b7 + last_write_checksum: sha1:449394234754da294f2965af62a5ea018cf58d26 + pristine_git_object: 20861776cdca766237f161631ca23d8e4d5fcfcb Codat/Lending/Models/Components/AccountingCreateAccountResponseAccountingAccount.cs: id: 3f5475f90f6c - last_write_checksum: sha1:419ffa19826e01bd949c1ac019a29124a63245de - pristine_git_object: 1121638ff47405d399fcf5c09db27f4eb9fa891b + last_write_checksum: sha1:387bda464b54705f2ef81efa7b548ce01c6ab926 + pristine_git_object: e6d4cfe7f06e1c62e2529d8756c1bbc6d8a57bb3 Codat/Lending/Models/Components/AccountingCreateAccountResponseValidDataTypeLinks.cs: id: cbb6ce0fa91d - last_write_checksum: sha1:09c9a7b6d19805f50c8625d977ad6c83c5f2f068 - pristine_git_object: 979022c8230c34ebaf7b0aedd0de2c00420d316d + last_write_checksum: sha1:3047cf02c2cf41a81af5e8f2cacc4a0fe2f881d3 + pristine_git_object: df377023281500c1e5d38b08d95bb6607634ae7d Codat/Lending/Models/Components/AccountingCreateBankAccountResponse.cs: id: 808cd37f3fbd - last_write_checksum: sha1:1c55a7f0ad21023a440cfc350a4e36e609ee0e20 - pristine_git_object: ea585bf39259bad8f6c9798d622ba5916a31f0c0 + last_write_checksum: sha1:85c36fc4b2e899f7c73e77368e28efd22bea6ba0 + pristine_git_object: 0f7b79d62ea4d973bcac86cff0b32c2f9524b149 Codat/Lending/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.cs: id: 0e3450fcd550 - last_write_checksum: sha1:7e853ccf4e5de1feae9d238f84bef05c1dbeb2a0 - pristine_git_object: c2704f971905d72a612b8bb67d9dc91929b92396 + last_write_checksum: sha1:b1e6c4a0b1d686bf36261ab6513650232b1faa0f + pristine_git_object: 4c21ff130a35e41fe81c54edafa7fc7b84790910 Codat/Lending/Models/Components/AccountingCreateBankAccountTransactions.cs: id: c7befa69ba32 - last_write_checksum: sha1:aa9374b62e3fc6748f64fb570bf76fe69db0f71a - pristine_git_object: 1268a70004e395b032e44da30289a4c18978c264 + last_write_checksum: sha1:9389dcd0a518d5fd7acc7a5686d6df674e7087c4 + pristine_git_object: 353a1b006f248c9ebd2efed42910b852bc18a7a2 Codat/Lending/Models/Components/AccountingCreateBankTransactions.cs: id: a5320b5867cb - last_write_checksum: sha1:7b722698041ab646dca7031bf79d31c1f492622a - pristine_git_object: 0cdbd6b1b58d704a092f5d57d50bc5ab6ef09e41 + last_write_checksum: sha1:70f142f2df26d16e3bf0f9f08d29bf293ae8bdec + pristine_git_object: 4f0e0830ae681e6788f26886ab632380feeca01e Codat/Lending/Models/Components/AccountingCreateBankTransactionsResponse.cs: id: 6ab32eed1f67 - last_write_checksum: sha1:7f4c9343c7b63ccf852089f90317299a82aa960a - pristine_git_object: e6212797fd2d2506d5b49ec4f532c591907bd793 + last_write_checksum: sha1:41deae04b1cab23bedbbea186684ebed75042beb + pristine_git_object: 0773c7367e708e283cff0a906e96a386b1c2d9b5 Codat/Lending/Models/Components/AccountingCreateDirectCostResponse.cs: id: 8bc664f3d68f - last_write_checksum: sha1:9028d469073db6e4376352fd27d22ef3fc0f7ebd - pristine_git_object: 97321b17ebee0bde5dad1dbcc780f05aa173591f + last_write_checksum: sha1:e4fa48aed7154d17238ed0c624c2f81573e60285 + pristine_git_object: e5d8330d128d8b324d462800d0fd5011cb407cf3 Codat/Lending/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.cs: id: ca4d1e13201a - last_write_checksum: sha1:f8705c39ceb69ef552546499b23492be053d79ea - pristine_git_object: 05939663aa10c4a8349ae99e313cf305b5af7da7 + last_write_checksum: sha1:2c1064ee1cc328c1f5f6d0366f1dedbcb7fb281f + pristine_git_object: 9c53ddf4f998d1d014379dcf4ee6f5c26ee84b6f Codat/Lending/Models/Components/AccountingCreatePaymentResponse.cs: id: e92a810c5544 - last_write_checksum: sha1:16c2b486d8ff50b0002b38e2448157c6bf3203d6 - pristine_git_object: 9ecb6d841fc797a8fa514243710fe90bdfcb1735 + last_write_checksum: sha1:6ee20b6b53977829e444804124153e087ccfe711 + pristine_git_object: 2326d69eeb04dd95d07e973b9b30d44967b9e951 Codat/Lending/Models/Components/AccountingCreatePaymentResponseAccountingPayment.cs: id: ec47ca9ab4d8 - last_write_checksum: sha1:007c10ca1521ea5ba3d9cfad367520b07d4326b9 - pristine_git_object: 0549e41b4bff6375967efc7132a26ba0fc771ebe + last_write_checksum: sha1:9c6c4aa5107d4c6cf647b1ec0ab5e323645e8d73 + pristine_git_object: 4c4a7860a579934f633b721e786adb8f5bf0b16f Codat/Lending/Models/Components/AccountingCreateSupplierResponse.cs: id: cb408b26e2b7 - last_write_checksum: sha1:645d09ddc34eaa028a99601931c8ab305232da8c - pristine_git_object: 5198646353e7705e2e4988a5bc7dab7c491c4331 + last_write_checksum: sha1:0d2074117571724a3161a54f197a8cb153932114 + pristine_git_object: 31c99ce7cf77ce0a82598e9edac99c3c7aeb5998 Codat/Lending/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.cs: id: 7fa3ba64f7ec - last_write_checksum: sha1:2e9fd0d447b28247a62d41d3e648c7c0449dcfbb - pristine_git_object: 110a4a3d06c4a491396bbc05ac4164feec86c155 + last_write_checksum: sha1:67393837926813f665bbc2ada879db3f0ee935bd + pristine_git_object: a8f18dbbe06667f8f76868457a5c6976e6488700 Codat/Lending/Models/Components/AccountingCreateTransferResponse.cs: id: cfac522de375 - last_write_checksum: sha1:81427967e72b4c7c9e54ee2eec3671c571d5b262 - pristine_git_object: 5d6c761d2c239ed4f437b4f75f7b7d8fc440d41a + last_write_checksum: sha1:c07fbab030d556d041ea6c9dfa34138e759cfbf8 + pristine_git_object: 2cac09dd9cd6e7c6de39cf8690979b0c9367b4f1 Codat/Lending/Models/Components/AccountingCreateTransferResponseAccountingTransfer.cs: id: 0934cd697d89 - last_write_checksum: sha1:3ab788833d0278d5a31cdedb288c6dda6141e751 - pristine_git_object: 5650083116fa5dac9c6c8338dde1a2e7c896f415 + last_write_checksum: sha1:3c9d705e1e3aa1979f6d6c06269cf9e8f27d1653 + pristine_git_object: 5ade55e473d56cf3df71a56177c208f12c7ad7e7 Codat/Lending/Models/Components/AccountingCreateTransferResponseStatus.cs: id: 6526dd776f32 - last_write_checksum: sha1:916a7bbf6b091cb44068ee15dba4c15ae85b9cff - pristine_git_object: d7dcbe58217efbe25802463d34d986364ff62b03 + last_write_checksum: sha1:5e63592dbaadb6fa2e023e30cdfcbeffa502dc23 + pristine_git_object: 2adb694cebad8aacebc7062467669559e3bd6c75 Codat/Lending/Models/Components/AccountingCreditNote.cs: id: 7096c0378cbd - last_write_checksum: sha1:e51b5e6635b0432cd176c788017d0a6a1f6d25f9 - pristine_git_object: aff56c93fa9c9326d89c0bd8951417a77852bde1 + last_write_checksum: sha1:fde40583bb1ed6dca233af6426cfec402dd6d756 + pristine_git_object: 50fa320fab303ebb3a2376dd2cc81e2d058b4dd8 Codat/Lending/Models/Components/AccountingCreditNotes.cs: id: 3ff01d2fa202 - last_write_checksum: sha1:51153cb3d84deb6f5ad56ff6385b3fda288e1194 - pristine_git_object: 77bd1ee335356c25af1215527f78038a244bd678 + last_write_checksum: sha1:63042bc901459b8aff68b970d5daedc0166d2ec3 + pristine_git_object: 94877da5eaf1f2320de5237d4c6552ba223124cf Codat/Lending/Models/Components/AccountingCustomer.cs: id: 5249137b9309 - last_write_checksum: sha1:e93e74a0586cad558ca8b91693e09f6e23381462 - pristine_git_object: 1184c7b0fc5f84bc8d88ad3625111b3339f03507 + last_write_checksum: sha1:51c0aee0274b9c8992ad077515c3ead8403fae04 + pristine_git_object: 46a31d3660e3543ffdd12f78ee2a4b2c237e604c Codat/Lending/Models/Components/AccountingCustomerRef.cs: id: 8e8b2f6b741e - last_write_checksum: sha1:3eeed686cba98f1a083ea75136825befb4640616 - pristine_git_object: 029af59b90c5ae60b94394faa0c951a68cf2013c + last_write_checksum: sha1:1f5d48079e6869b1c49e2d92fdfed09b652235e8 + pristine_git_object: 744a1c1e9e50ff04d1fc3b11bc6378bbee6ab9d1 Codat/Lending/Models/Components/AccountingCustomers.cs: id: 220eddc435f2 - last_write_checksum: sha1:8d4ea073ed0beeceefd9e5b54183a7c85d0d531b - pristine_git_object: 0e3660ec8f6b146e37c92540f3fdbf84023936a2 + last_write_checksum: sha1:fe174fd2f6f4de9b0bd25feebbeb884bfd35c912 + pristine_git_object: b11b5b1d00161827d782f1470c455f0bb5d19c71 Codat/Lending/Models/Components/AccountingDirectCost.cs: id: 0a5bbc83100a - last_write_checksum: sha1:c20547e30cdc75817266d37ca8556aaa5ee5282c - pristine_git_object: 92859f20cc3f6f20dba8372e2d32cb42d0321606 + last_write_checksum: sha1:61b424778b6cfe5c374f591ffb1f8c351dfa516f + pristine_git_object: 106decf970bfb57606f5401460641057f2823b93 Codat/Lending/Models/Components/AccountingDirectCosts.cs: id: 989dffcba4ae - last_write_checksum: sha1:39bb614773c37057cf315e0849ef23c458069687 - pristine_git_object: 1ec6b573afea067e659c90e7c7255bb4067882ec + last_write_checksum: sha1:d2f05a32a9424147e70ae6e108cbcc15bb5725db + pristine_git_object: 2a5945479115436a2f9e3c6b97d9673a3966f630 Codat/Lending/Models/Components/AccountingDirectIncome.cs: id: 255589bde4a5 - last_write_checksum: sha1:6d9f48df61b51f1dafd5da4bbf2e625ff3ae1b8e - pristine_git_object: af2f1ac3980c7925cf912c75e4661428667fe1cc + last_write_checksum: sha1:502e9c1637840ed952428e8f4b070fe40d890398 + pristine_git_object: cc1a500639bf0aa61fbfbc70f9805c0e1cbfebf4 Codat/Lending/Models/Components/AccountingDirectIncomes.cs: id: 402d11f6de26 - last_write_checksum: sha1:3e1bce663bb375868700d8cd1ea7ec747dd6305e - pristine_git_object: 54b532758a1536150d2dbbe3ffe7eaa18c2c6f9e + last_write_checksum: sha1:6468e7438d40f0c6a9f93078fa6d2d8ea7704430 + pristine_git_object: 818817c13e33f9fe6ae0a0e229e05af0585b148f Codat/Lending/Models/Components/AccountingInvoice.cs: id: a7a25b88efd8 - last_write_checksum: sha1:17c7d39f0716e43998617f9c2f91251971733154 - pristine_git_object: 123529262792ee73818a9faf2cc84190be5cae47 + last_write_checksum: sha1:86fa98a0e1a8c89d8b6b1d7c77c10183d3732bc5 + pristine_git_object: a7f2a4d32e4aecfc305630ea2d162aa158163eae Codat/Lending/Models/Components/AccountingInvoiceDataType.cs: id: 0009c4024eee - last_write_checksum: sha1:b04e0a299d332e7793752ef4c5b964e08716f504 - pristine_git_object: 1fe74f9b54ef01dedba3faee1e1bec4726056652 + last_write_checksum: sha1:edfb80beaaf0ec4b2efad2318969d07b5a551303 + pristine_git_object: fee62ceedf15945667ce0294b7c2771b030bf8d1 Codat/Lending/Models/Components/AccountingInvoices.cs: id: a7375ab1710b - last_write_checksum: sha1:f1779928862c63715110c4fe1fc8b1c53d0a3b69 - pristine_git_object: a427dd4d1669142d8c905a7be394011353ebe353 + last_write_checksum: sha1:79fc09b1e918918de45c73e7b7ffb280e76caea7 + pristine_git_object: 2020c92540974191ed8ef8febe6d33ccc91741a6 Codat/Lending/Models/Components/AccountingJournal.cs: id: f945fe69d646 - last_write_checksum: sha1:28d2a52a708658ea1ca9cc9affe21bec8a2db102 - pristine_git_object: 0faa4e3df7424665cd5dcde15e266525aa1520e6 + last_write_checksum: sha1:4eda735fecc2ff638cb53539e43a70dca6589d1b + pristine_git_object: d0f186434107a9e6ff9d892f5958c761d4e24119 Codat/Lending/Models/Components/AccountingJournalEntries.cs: id: a151530d5e40 - last_write_checksum: sha1:5321ea3dbb510ba44e5adcdd44c97399395539cf - pristine_git_object: 4eb1185c35364d144767217f9d088d21c97b289c + last_write_checksum: sha1:428d2a3a44ecbd301e6fd7dfac0925d40440b421 + pristine_git_object: 2d0f21e143d1c399a9d7ede964e66e32fd4f7780 Codat/Lending/Models/Components/AccountingJournalEntry.cs: id: 44c3d1b2441a - last_write_checksum: sha1:7c07e799ab9a67e277edaf95a76830d3a7a58f0d - pristine_git_object: 9c7b5b613164ef9cacc666fbba317d8384862d17 + last_write_checksum: sha1:9834741d748d63d08b41d65208ace32240474bba + pristine_git_object: 4386fbc494bfecacc79e6a3150e864588e5a6156 Codat/Lending/Models/Components/AccountingJournals.cs: id: 75ddbd178c1f - last_write_checksum: sha1:76e41b87cbb997fa2a528557e27a21753603f604 - pristine_git_object: 802630cb1752e8d5de70e37e4fef1368ef3d4edd + last_write_checksum: sha1:5dc817579e51d7b90207559bb52ba067f8c4156b + pristine_git_object: 58697f0ed58406e8fd39732e46051e0bb9b7954d Codat/Lending/Models/Components/AccountingPayment.cs: id: 2069341ac4ea - last_write_checksum: sha1:6b0ecd2c41389ff6684a9b2cece69bcfe2e2f5ec - pristine_git_object: 8f2ba1e580e051eddd89d0880504091a7a57f9b5 + last_write_checksum: sha1:eb998cf2d403c54f77472287f9d7540b43b2398e + pristine_git_object: 4f83f8386cb9d97922780143ff0fb435beec537a Codat/Lending/Models/Components/AccountingPaymentAllocation.cs: id: 32c11c0911d2 - last_write_checksum: sha1:3a6c604217e65357e6d349ebb0911d3f457e7573 - pristine_git_object: 66b2cd833d22bdd627b0ea9ec61cc7eb99002391 + last_write_checksum: sha1:95bc524c6a4144948ed412656281f42385ecfae8 + pristine_git_object: 536a6a97c97765edd4882c872b041195ed04a562 Codat/Lending/Models/Components/AccountingPayments.cs: id: 59d1d2e53274 - last_write_checksum: sha1:5717597919a53f7dea5b68460cf1b5c14e76c167 - pristine_git_object: 737c0825780fc98e1251fe7716397cf279efbf1f + last_write_checksum: sha1:14c153cb82d745ff768df79ad3d4460281eaacbf + pristine_git_object: 47a000878c27ce9f2007b1e2d5b46b5e9527c65c Codat/Lending/Models/Components/AccountingProfitAndLossReport.cs: id: 609ed8c76451 - last_write_checksum: sha1:2d8882278dbb710443cc839b4dc71403bd27c148 - pristine_git_object: fc4592845862cfc17b06cd5237b3affe69f0c3c4 + last_write_checksum: sha1:181ad7f77cd0ce7269a162e13c7b9d2abeec4c63 + pristine_git_object: 66b1294a1c3dac1d8d4a06360cd6f71c4ea8bd38 Codat/Lending/Models/Components/AccountingRecordRef.cs: id: 007c1941be76 - last_write_checksum: sha1:9c62e654c847c403411a4f4b661a4a8f6e4f887b - pristine_git_object: e344873d819546672698e7e4ee97df0d4b9fc014 + last_write_checksum: sha1:c379fb3250b0148958091370dc9005a87edca134 + pristine_git_object: 831b5827f7fe80ddc31c45b752f395e3f4c00b17 Codat/Lending/Models/Components/AccountingSupplier.cs: id: 6995863cb8db - last_write_checksum: sha1:d51d029d50bc6801cae61ab391a0a1c75c95d561 - pristine_git_object: bd069f55bfbc85678dc143ac8197df1f2714cdf3 + last_write_checksum: sha1:93e4b9767e4eaebc7e8685f51d4cb1df496fb2b7 + pristine_git_object: 11fad730e878ad09458f47d735469c4e7b31944f Codat/Lending/Models/Components/AccountingSuppliers.cs: id: 4e277c4b62d8 - last_write_checksum: sha1:23cf553a9229e75e231aaddf290d4648cef75d72 - pristine_git_object: cf2674c771c947237549ba44b9def9763bc3eb27 + last_write_checksum: sha1:7cf7344fabf63102206ba6018a0be822b4ecdd99 + pristine_git_object: 57149a4cb32ac61a74f0833aaabdbfe805aaab53 Codat/Lending/Models/Components/AccountingTransfer.cs: id: 5463ce5d58a9 - last_write_checksum: sha1:6ebc3ff5602489213699af7e4dd81097bb9e90ce - pristine_git_object: 3e9a23e8e0e62016118dc2a12868f9a0a8bfcca8 + last_write_checksum: sha1:5119f3e14eb422e2518372d37b7636f85b9a1708 + pristine_git_object: f9dfc991b4c7a9c248a8adfbdf655cbd254d7ff2 Codat/Lending/Models/Components/AccountingTransferStatus.cs: id: 8cb8d2f00e51 - last_write_checksum: sha1:651f39a7f393b19f740f800fbbd51dd39b81292b - pristine_git_object: 97396a01a105c543e5928515ac2fcb6f5a009bd1 + last_write_checksum: sha1:0dd70b046713911b89812898747c6cfe3c123253 + pristine_git_object: c316c967dc1df3ac087c0235ea246f1d841ae1e7 Codat/Lending/Models/Components/AccountingTransfers.cs: id: 5200acb82089 - last_write_checksum: sha1:2ee4385a8f91cd1eae72616d916725f0a157a730 - pristine_git_object: 554a11c706c08e813d75535f37a116d70e8ae0be + last_write_checksum: sha1:7c1ad011ed5dab251c6144eeb5fca7e924758dc6 + pristine_git_object: 9129fe47d0636e2d13a4c75f2f70aa37b0855078 Codat/Lending/Models/Components/Accounts.cs: id: 55a0c7d26bf5 - last_write_checksum: sha1:948cd3bdb9b39449949e7210beb9e1d27f58056a - pristine_git_object: 4e31009e935ca0cec07373d573d20c11fe84ee5a + last_write_checksum: sha1:437bcb7660f25980b98b6a5fcca08e805a9435b8 + pristine_git_object: f2280e947afb005ad6442c6eefa7c3c76d61d4ed Codat/Lending/Models/Components/AccountsPayableTracking.cs: id: 29bb99305969 - last_write_checksum: sha1:eab465d245571cd6d9e2ef95a02e8c8bcd30531b - pristine_git_object: 1c9002e9286d15b718bebe520e0fe4097d6da848 + last_write_checksum: sha1:6bfbb665a293ba5c384d44b311578cc0e907c9ed + pristine_git_object: b3489f858c806010328fb1a8efaa4e5713e539b7 Codat/Lending/Models/Components/AccountsReceivableTracking.cs: id: 711dcfdd10c5 - last_write_checksum: sha1:59b0052fa473c5f984c03d46933dbebeea45eb5e - pristine_git_object: 5c9432a68396052266216145bd9e8e44995a99fe + last_write_checksum: sha1:c1ece0f2835215a1a87572b8dfd43a860b93d0b9 + pristine_git_object: 0809f4f0923f0fc29a6d29e5922ecce6cc0a4705 Codat/Lending/Models/Components/AgedCreditor.cs: id: 8e2236137b91 - last_write_checksum: sha1:3f4bb0b404426ca440faf5983dfdc3a7e6e501dd - pristine_git_object: fdd09834138b312799f790884d3d7ef9d2334b72 + last_write_checksum: sha1:7c4c1f24ee125cc5d1c0cb7b7f1b2b40efc93733 + pristine_git_object: a64c336cdffdf08f4a090201507166c5a6632c02 Codat/Lending/Models/Components/AgedCurrencyOutstanding.cs: id: c884729069e6 - last_write_checksum: sha1:a68b571dbdebf12a2dbdf0934c9a7c04f6b4c1b7 - pristine_git_object: b2d9a6770e0e0b1e4cdeefb3f8547a783734d268 + last_write_checksum: sha1:2248dfee4aabbca4ff442cfeffcd18d6424d4527 + pristine_git_object: e3afb81d6d55599d19bf8e8f1da45b54a05bf7d8 Codat/Lending/Models/Components/AgedDebtor.cs: id: ae1b84bf9161 - last_write_checksum: sha1:0aa77cc0d3e37b52f9dd43120e5ba5877bff3017 - pristine_git_object: ebcda3a7ec453e0788f4cb60e5489170c3aee84b + last_write_checksum: sha1:eca8d6aeadb037099ce0eebe61e4a6187dc638c9 + pristine_git_object: 12aee9e559520dc9329faab94843dac66220ca46 Codat/Lending/Models/Components/AgedOutstandingAmount.cs: id: f3b55e87806e - last_write_checksum: sha1:4da2ca0c9dc8ab09b58239dfaf41959f397e90b5 - pristine_git_object: 9409d29e07dc861edee973c8703c2c79d424838c + last_write_checksum: sha1:e68c30e679b92532ed0544937cd498c2c54aea0d + pristine_git_object: a80c12bc986013669aa618f67a657856962dfc27 Codat/Lending/Models/Components/AgedOutstandingAmountDetail.cs: id: 16abc2c7c9df - last_write_checksum: sha1:9fd2d9cb978de9ea839e716e4f42ad5768000711 - pristine_git_object: eb80a727108c6102312bc39fbc6124b25c5e514a + last_write_checksum: sha1:e9dde0c0fb2587e049d6cf080dec0e5064e8ec65 + pristine_git_object: b2f67108fe87a194ecba18ecc6c0f7e807041717 Codat/Lending/Models/Components/Allocation.cs: id: 87f729b9d07a - last_write_checksum: sha1:ee6b44615113e8fb879a84712641acb8c5fe4dc4 - pristine_git_object: 73365c036b8a3948f6bba95cb8d09c0669c4ae97 + last_write_checksum: sha1:a1b1b7f64a3358944f936429271548ac4c0a565a + pristine_git_object: 5a121d99356d7bc365e1f519a70660a908b340a4 Codat/Lending/Models/Components/Attachments.cs: id: 33c54f77ea67 - last_write_checksum: sha1:a0b2dabe82210054322d37ed038ec42372ca5fec - pristine_git_object: e32f4d9cdc062d7cc995e9b2690a9662aaaec4dc + last_write_checksum: sha1:8201dcde64772347f6e97470717aeea0527b6d40 + pristine_git_object: 6cd8b6326490050a3be0c1627fd5cdde9fbda5e0 Codat/Lending/Models/Components/BalanceSheet.cs: id: bc9787abf27b - last_write_checksum: sha1:f7bcb60a499eff40fd618e200ba4b0ee01b21b5f - pristine_git_object: 0bbd1ffe0b75fd9319af18784de2351e95d95f9c + last_write_checksum: sha1:a673f0570fcabdf485c9029372cef4f9043185b4 + pristine_git_object: 96fe747928e3709701a9e172459e270b0d1ee539 Codat/Lending/Models/Components/BankAccountRef.cs: id: 3ed6a92f3aab - last_write_checksum: sha1:935820e0b64670fc8131ae596a90450282eb0752 - pristine_git_object: 9c4d5bc246984ab6530086690c6279e794d6fd24 + last_write_checksum: sha1:0da58476609fa4a824443f0834ae3eb6836bf06b + pristine_git_object: de36a8042a230200b94a234cc5a3adc57e23255e Codat/Lending/Models/Components/BankAccountStatus.cs: id: d797481f030c - last_write_checksum: sha1:5ce5a5ecbd7986076c729c74a07f9ecc74c4e6b2 - pristine_git_object: 0e249728e1c3617cac80a6a2983ec2cfc4f21cb6 + last_write_checksum: sha1:44b40c50f0e14da954334ceab9e2ae3b3e291a4a + pristine_git_object: 77235933c8f9220397feea1f56b0b2eece2fb518 Codat/Lending/Models/Components/BankFeedBankAccountMapping.cs: id: dbcfed5fa215 - last_write_checksum: sha1:ee1af17590aea3e0bb5ccf65301412a55ba62169 - pristine_git_object: 28c1405164302fdf3b0ac378d2db65c3bbe605b2 + last_write_checksum: sha1:8f91dacef9e9c10457839a01921ed8eff1a6ffa3 + pristine_git_object: f1a0c7d91a8114d08ce581b07074821099a00a07 Codat/Lending/Models/Components/BankFeedBankAccountMappingResponse.cs: id: e5a26432d601 - last_write_checksum: sha1:68e8cc770a3e7dc9dcd77ef61059a317054d6539 - pristine_git_object: 3e83bb9bcf8a75b8be22681b35f985224f9e9a78 + last_write_checksum: sha1:bf4334bc5b7dd9ee43c4d8886690cd3f258fcf1a + pristine_git_object: 7beb5bfd56c1785f2b0ce20b7d87c8d67e741d88 Codat/Lending/Models/Components/BankFeedMapping.cs: id: ad73e7fe46c5 - last_write_checksum: sha1:3429085c6591d410bd294627d8d9d9d897a6cdf8 - pristine_git_object: b98042a83edb7eb73df5475acb77812c3a82f85d + last_write_checksum: sha1:549aeac47c14d359aeb91872bf40465e50aed6d0 + pristine_git_object: 173a020d8987a9e625690b3ed436a50f0692b816 Codat/Lending/Models/Components/BankStatementUploadConfiguration.cs: id: 9f0ecc07a7a7 - last_write_checksum: sha1:355db5846b97ce875a6e8d290e1a8ad637014b2b - pristine_git_object: 629d3dcf68e115507d56049bc270a1550e72e5f2 + last_write_checksum: sha1:a977454f8911795a0dba0ed094d345ced6467c76 + pristine_git_object: b1d5765b622bf261c0cc0ae86ec2aa4c50f99371 Codat/Lending/Models/Components/BankTransactionType.cs: id: 0f19f49ae63a - last_write_checksum: sha1:dd835f57eb579297316801c11989e83699c502c9 - pristine_git_object: 41b70c9d58053edbf63449a109d4d37b5e74c413 + last_write_checksum: sha1:e5f414fdba21a676dba02a04a99ac945d43aea7b + pristine_git_object: 1c1cb2549617e603cd1c40456cd4033ec83cad11 Codat/Lending/Models/Components/BankingAccount.cs: id: 43bd4f4eb5b0 - last_write_checksum: sha1:65099c54b182f456adfc5d3afe4228fe47a3094e - pristine_git_object: 7a17a5a58ff88feae3cc8455d69c440cd4578750 + last_write_checksum: sha1:67d9c1cd556021053f7d941da778e42955be4c9e + pristine_git_object: 66e69f7f7b9396bdb4889e34404b73feeed6b387 Codat/Lending/Models/Components/BankingAccountBalance.cs: id: 8c09a0536cf5 - last_write_checksum: sha1:58f41488352253fc5098f8ad4a9733efa6ca980b - pristine_git_object: 64c3c85f245f94c124c80dc84fa14c76108c3578 + last_write_checksum: sha1:fa01d6a2cd8c8975cd5b801eef67dfa39a0b4bf5 + pristine_git_object: 5fd616110da8440aaf433fd25bd4e36804c8c405 Codat/Lending/Models/Components/BankingAccountBalances.cs: id: 0439778dd685 - last_write_checksum: sha1:3b16e9db5b276c34cc8a9c184bc214cd7f9086d8 - pristine_git_object: 4b833099becc39f60684e3ad22faeb736e866a3c + last_write_checksum: sha1:31b28539cea9b124ac5b0c8e0ea717faffef589f + pristine_git_object: 16a6e52c1c36d4fa8c4a9062b8d1e484c5ae74d1 Codat/Lending/Models/Components/BankingAccounts.cs: id: c0e46d39ee7c - last_write_checksum: sha1:d9f452e2be65c90b84ef91c2ebfe09ef3d588d3d - pristine_git_object: fd546bbbc4913b30ee90af7352cde2cf896e3acd + last_write_checksum: sha1:e5f9bd469dba1c458200d6ebd57f591f4c04f9ac + pristine_git_object: ae95563334d7eb818eb082347a21fbc703ab91bc Codat/Lending/Models/Components/BankingTransaction.cs: id: b73a86ffd8ff - last_write_checksum: sha1:212eccc2821ddbc9d7de53feb13ab30f00fd6493 - pristine_git_object: 2c0f99a0465b6bd6d4188b40aeeb162b2dc3d145 + last_write_checksum: sha1:69a526ac9eadd9dc58e5b89872a7fba3d57a2d36 + pristine_git_object: b739f2fa4d68816b215cf1cded4b8ee079fabb9d Codat/Lending/Models/Components/BankingTransactionCategories.cs: id: 3bf9fa0134bd - last_write_checksum: sha1:9efe750b10facc8843250e786dccc51da3fe84dd - pristine_git_object: c2f8bb4f57b67b6df93646a43d98ba76c3985c9b + last_write_checksum: sha1:fc92a86733ec4805f93a368311f4542436348868 + pristine_git_object: 2a5b78aec3d208c93a387cedac38299af18ada89 Codat/Lending/Models/Components/BankingTransactionCategory.cs: id: 6de933fb84b3 - last_write_checksum: sha1:4f1eec9f801397b4857f9aa49c0bce95d9c202e2 - pristine_git_object: 86be5a39661304eefbb8dd895798c41d743d249f + last_write_checksum: sha1:8427ba67ec29ec15934ad5f52a21ed277f92da1a + pristine_git_object: fe6faea417001b0d640cb6630e3bff64df12293e Codat/Lending/Models/Components/BankingTransactionRef.cs: id: 99aa857adc69 - last_write_checksum: sha1:1aac84d91e344222124e65a720e61a04768c1fd8 - pristine_git_object: c939ae54430bec1aa878bdb34ec673a2852efe6d + last_write_checksum: sha1:22d87c7f471a739e8aa8e71d7007eec8df9ca68c + pristine_git_object: 58c61409516ca2e99294e00bcb2f8bb92bae5f35 Codat/Lending/Models/Components/BankingTransactions.cs: id: a7d60270e9d2 - last_write_checksum: sha1:824a0f3617b87b7ea6f0b69fd8fead71869d5452 - pristine_git_object: 88fa2bb70bba205a477c47b6eb1372f2faf2d59f + last_write_checksum: sha1:65b55b401dd3a50163f83df358432243f79947ea + pristine_git_object: 6e132ec7d8093172837c126c0ffc88b356cd36bd Codat/Lending/Models/Components/BillCreditNoteLineItem.cs: id: 61dc148001a5 - last_write_checksum: sha1:cfc3616e6d9e7954afbbfb270fbfa5d336b6bcd1 - pristine_git_object: f5fe8114b51fc386d389e6f3e1c5b2afdb64b670 + last_write_checksum: sha1:1bbcf6ae28739bb5696447c6d81fb129905f05dd + pristine_git_object: d7357c8ce40408aa2d22381f47ccf2fff47e7030 Codat/Lending/Models/Components/BillCreditNoteStatus.cs: id: 545f02f4d5d2 - last_write_checksum: sha1:9c7e36a2ec03dc24684f6473e3fe92f0ee4ebaed - pristine_git_object: 9113d0faaaa3decc8152367e492c7749f530a971 + last_write_checksum: sha1:36add328682333c38cb8895a30e87fdeef7875b7 + pristine_git_object: 7a244f0e026da937cb35d3f5abd61b8d6a65b95f Codat/Lending/Models/Components/BillLineItem.cs: id: 339dc22a4209 - last_write_checksum: sha1:b746ac4873753bba0559566e19718c6f6c4777a0 - pristine_git_object: a651df88290e4a6aadcde7d56f602bbc0d4e17d7 + last_write_checksum: sha1:cbd6a46116a885a78c84543f6d4755a232e6f645 + pristine_git_object: 6b4fe7e03a1693315a70d03ffc6f24c7e9321cb5 Codat/Lending/Models/Components/BillLineItemDataType.cs: id: 034ff1b49114 - last_write_checksum: sha1:b7cc71fbe91de1694b38dbbec8881bc08c558991 - pristine_git_object: 94d25f81ce26cc422f24f9cc32087dd50abaee88 + last_write_checksum: sha1:49bc21f6035e0689ebe29089ff94e1ff5de83d19 + pristine_git_object: 98d9871bfd6e6d9ee760844658dfba1f8ece07fb Codat/Lending/Models/Components/BillPaymentLine.cs: id: 53b791b18a1c - last_write_checksum: sha1:fe945344806dd997d71964e110c013f52306c178 - pristine_git_object: 689c5f9448d70905561ab3d0e78c84170c722700 + last_write_checksum: sha1:b23b565f77148d3f001e8a2178d008169ded0d48 + pristine_git_object: 57b5d35ab586fe76ae036403e68c1bb5c614c5bc Codat/Lending/Models/Components/BillPaymentLineLink.cs: id: a4df944a4c00 - last_write_checksum: sha1:254fa35dd041e3ff65825191b6e8eec41e6a2483 - pristine_git_object: 1d7d882ed8a0954f62de5387a9f7d3ec3fe1c7b3 + last_write_checksum: sha1:e47959338ad08d3615c5a0251fdfa202a3b90c5a + pristine_git_object: 9ad1c7665b23d24f23fff0b7ee2eca4d20a0a580 Codat/Lending/Models/Components/BillPaymentLineLinkType.cs: id: 6f49d3ac8158 - last_write_checksum: sha1:e152e34b828a6cfe2fcdeb4d307d0ff85f496a7d - pristine_git_object: 33e44d7a4cdd5655e66e60f8cb5d3f842c0fc7b2 + last_write_checksum: sha1:374aee6b46e48156169cca5c0d5fdbac4058a370 + pristine_git_object: bfc4d3d298f25d42e9d4e22c4571d7b5ad60d0e4 Codat/Lending/Models/Components/BillStatus.cs: id: b56632300a66 - last_write_checksum: sha1:d967ac9a23f940dc2b29b331479494117a84b9e8 - pristine_git_object: f9313ec9076838f66f938826c6b0600bd8ad5222 + last_write_checksum: sha1:1d7e4b927569adaaedaeb4b35b8b3f54aa855db6 + pristine_git_object: dc2bb8fc253a9df991ea0dba083064f9d4375982 Codat/Lending/Models/Components/BilledToType.cs: id: 5fd869326d16 - last_write_checksum: sha1:36df866851b362c6b3689e133f7f822d7b035e29 - pristine_git_object: b5ae787ca48c2166a5bb5cbfb23199e75d116a32 + last_write_checksum: sha1:2bba27ad8e8e412b72915f40751933c500f2ff05 + pristine_git_object: 57bffa1fa382f492081744a3d67c9ee1f8cb3636 Codat/Lending/Models/Components/BilledToType1.cs: id: 08a4bc9a5242 - last_write_checksum: sha1:99374f41e232f2247d3d373f2c89bfa1e14b5e3a - pristine_git_object: 03a69211c2827d87cbfbf5e340308b55a922c73a + last_write_checksum: sha1:2da43d90442c2afe75a2e055f8e2eb03557f62ba + pristine_git_object: 4104b150877c43b549efed0ad555285e4e07f334 Codat/Lending/Models/Components/CashFlowStatement.cs: id: 4d5d3d54ac2d - last_write_checksum: sha1:b6454aa6855a2a2f3d2f7464291707a53545b5f4 - pristine_git_object: f489426c1cdfd43083b8433a7db0c7fb56cbba1c + last_write_checksum: sha1:d5a9d45940080fe1d11dfa77444ce70fc44b672f + pristine_git_object: 48b738c6f28727dd91434166095b1b4e85f2010d Codat/Lending/Models/Components/CashFlowTransaction.cs: id: 67ce6b264aa1 - last_write_checksum: sha1:b53dd3ab824df333492a287ed8932d802fcd1e21 - pristine_git_object: 4a44e08b25736edcab73d778ec6b13573d8b1dcf + last_write_checksum: sha1:0dfdcec850cb1b43ca510c0a2e9ff147dec69ec4 + pristine_git_object: 85def732cd4fb70a1d1a3512fb6ceac6e9d0065b Codat/Lending/Models/Components/ClientRateLimitWebhook.cs: id: fc24363d8be1 - last_write_checksum: sha1:02089a367f3f697f7c05e74ff725d4a2ae93f5e5 - pristine_git_object: 41ebc75a791a71e616eb82faeee4c4476d7fe2a8 + last_write_checksum: sha1:4c750f695a7d96b38686a04d4719c259da0029f8 + pristine_git_object: 22bf11174f94f57081276e6b854357237aff391a Codat/Lending/Models/Components/ClientRateLimitWebhookPayload.cs: id: 4267c47af170 - last_write_checksum: sha1:541b88754163ecee20ad38a967c42fb6c6be11b3 - pristine_git_object: 1a74e4ceeadff55fb9e52928ca774aeda8263811 + last_write_checksum: sha1:b2bb1d30448b7dc1446c6c7fa771a6992b7a1ebd + pristine_git_object: db2a6bea320d3a4b0470f32fc8c2984b7c4e6a97 Codat/Lending/Models/Components/CodatFile.cs: id: 27d4106dbbba - last_write_checksum: sha1:a56dc4aa475abe5a0012d64834efd85dd28470fb - pristine_git_object: 240c9f460630b618cdd15f05765c41557a6a3298 + last_write_checksum: sha1:89e98b3a6d867a15f74a4a9b265c3b601a481b91 + pristine_git_object: 8dd3faccef377ffe3058281e063f5b59ae09c7fe Codat/Lending/Models/Components/CommerceAddress.cs: id: ff086cdc1bcf - last_write_checksum: sha1:8c8988a7147c6ef42dc1104e4ff8e9d46c043fe8 - pristine_git_object: a14029208295c5163263ac856fcf63a43796b158 + last_write_checksum: sha1:312aa89f7d8f1628e81c09cb239aa56a23af5c5e + pristine_git_object: 2015802c57095e19a14d697d6f80de754b070548 Codat/Lending/Models/Components/CommerceAddressType.cs: id: 84c54ecfd59d - last_write_checksum: sha1:36e50ccaba4008105136b653e09c79460dc2b1da - pristine_git_object: fba65c8e6275b94f3c16803c0f1a98997909f5e1 + last_write_checksum: sha1:30d0a36c431efe4e118a5f646f7bd9063add053b + pristine_git_object: 7ba14422ea9bfcf25f5b4874e1d97d43b4dbabe1 Codat/Lending/Models/Components/CommerceCompanyInfo.cs: id: 43f64a5cbfb3 - last_write_checksum: sha1:fe85d9854d5b402721951f3e8005f3c3aa50c710 - pristine_git_object: 5e076d81e48f8079b7196150c04b89b8dcdfa9e8 + last_write_checksum: sha1:fc16ab62f5338252effc098305eb9c9dcd5c85df + pristine_git_object: dab4fc3727dd8b4ca2ce49155785e0924cf2a84b Codat/Lending/Models/Components/CommerceCustomer.cs: id: be51520b63bc - last_write_checksum: sha1:d110964ad57625e83ea186bd401d3cfe137cd634 - pristine_git_object: 82691b8d8d7deb8a85187864bb612aa5c8c625a6 + last_write_checksum: sha1:525aa5c41df8d82fbde0d27db0f3759a1aec9857 + pristine_git_object: 5e27d6442567100496d04081670c249ddf4b713b Codat/Lending/Models/Components/CommerceCustomerRef.cs: id: 707df5e1442f - last_write_checksum: sha1:7fd7543d56dca5f93593e27d4c67e00c7ecf77d2 - pristine_git_object: a9749d5251e6810fa75c925d4207e3267d4e7742 + last_write_checksum: sha1:8d90d71dd00c607d96a49cadc510b10633a59775 + pristine_git_object: 8003fadd3971fe185f71ec23f6e5611592e00c6e Codat/Lending/Models/Components/CommerceCustomers.cs: id: be991e9ea494 - last_write_checksum: sha1:b56ae9a99d07f72529381453a41d9096428d8683 - pristine_git_object: cbf3a801316168ff77171310c783d23b06de1bbe + last_write_checksum: sha1:7d5a928fb36eae7a0a5beada00d338becd63379f + pristine_git_object: 4bd61f3147f254d5d85391b2083a87bc2d682af0 Codat/Lending/Models/Components/CommerceDispute.cs: id: df188b517818 - last_write_checksum: sha1:60dee24caa803e279d5d6da46e7ab2b6e4bf7ae0 - pristine_git_object: 84f3e8f25f16bdb1868a22a53330aabba91cbf1c + last_write_checksum: sha1:814e1a0778818395fba18d22b1bd650a669c7687 + pristine_git_object: 4e431800128c5503ae7911eaa8f0d308dcada8cb Codat/Lending/Models/Components/CommerceDisputes.cs: id: 9450ae217f5c - last_write_checksum: sha1:7f334df95e2ab9572eecfc1275ad435448ac35a9 - pristine_git_object: 000da4cd23c64087f9f56f7cfb25cec7118fc0bb + last_write_checksum: sha1:d104b81f914515dce961e1c6d4cee6bfbec811d3 + pristine_git_object: 793463f1218a4d187d6fd8d13e55254a24249fe7 Codat/Lending/Models/Components/CommerceLocation.cs: id: cad6d69d09e3 - last_write_checksum: sha1:d33ae999b7f8ebb0a21c02f205420ac5c091bd8c - pristine_git_object: 2566dea510ec235fa5321d6a9c1bc6ec18716613 + last_write_checksum: sha1:f6a12ddbdb13ba9358e99ddfc08b1e54eef10e0c + pristine_git_object: 81f8122826bdae091ef2b0472c98419949d68115 Codat/Lending/Models/Components/CommerceLocations.cs: id: f0c921b3d8b8 - last_write_checksum: sha1:ef7c9fd13fac4e386e15060837fcf7b633e6367b - pristine_git_object: 131e99caa6e3e64e7f732d800e7585fdcbc1a725 + last_write_checksum: sha1:82e0fed906670c0fb8092d56d7790c6680f81a90 + pristine_git_object: bf890bfa7396aa4994e051c480ec871882f062ba Codat/Lending/Models/Components/CommerceOrder.cs: id: dc07db00f741 - last_write_checksum: sha1:53c4ad4f1472dc09eddd3b6b25611a6006b51ec2 - pristine_git_object: f183dca1d8f1350e0ed37c629d6a363f228f59fb + last_write_checksum: sha1:52f7f6a139d29955f3d03f37b8399d739ad0a870 + pristine_git_object: e0c9fb8e3bb2563290fe575691d31f5c7c5c0b2b Codat/Lending/Models/Components/CommerceOrders.cs: id: c1d1e2bf48c7 - last_write_checksum: sha1:c2060f39db18fc99d31a3f6c0666c30ab021e22c - pristine_git_object: 14ebf071d5abd2cff3fe62ec151cf0260aa26343 + last_write_checksum: sha1:35f6e77df6153ecde8702fffeb3edca6e37ca347 + pristine_git_object: 218936883f0b0ce22e28dd44cd7927a5967fcd0d Codat/Lending/Models/Components/CommercePayment.cs: id: 8e2d79e96629 - last_write_checksum: sha1:0e45e5cbd091f39f35132142b7f20ffbe63ed722 - pristine_git_object: b60fb98a0eeb8585b269318eb0e0c50589c896d6 + last_write_checksum: sha1:bcc5025477ef97312dc9829b3ba7ef3cf082818d + pristine_git_object: 312fb17aaffa71fe968a1a576b56956ca6e150b7 Codat/Lending/Models/Components/CommercePaymentMethod.cs: id: 811c0756131a - last_write_checksum: sha1:eaff39deaf641f49fd8c57197f3ed89ad6af9597 - pristine_git_object: 2f555f2eca1ada0eafcce08094a52619e36f1d03 + last_write_checksum: sha1:80cb139bb940597c83b5e5ac2307dbb886fdcb8b + pristine_git_object: f3932a53f3b816bc6d4ee50e103a5eed95418443 Codat/Lending/Models/Components/CommercePaymentMethodStatus.cs: id: 3620fb08bd56 - last_write_checksum: sha1:19771e7676c268e778a186df5c9d9bd148848294 - pristine_git_object: ebeb71f7b13e1f12775935c6a46b0b199a3caa2d + last_write_checksum: sha1:fa0931686022137576a58de56410222a63bc7b2c + pristine_git_object: 2e166530cf10b2cf61312218ac51903e4b933331 Codat/Lending/Models/Components/CommercePaymentMethods.cs: id: 4adc1cbdbf7a - last_write_checksum: sha1:94fe60f2bb02ca3cfac519c01c9fc76394ec2655 - pristine_git_object: d1bb12e9d2f7ae09c3c376fa032f9284e0f64f66 + last_write_checksum: sha1:248698699732c4e77cdfc2991d84442ec5fe04df + pristine_git_object: 6f56a83975357adfa5f438f69d2634e8c96e1257 Codat/Lending/Models/Components/CommercePayments.cs: id: 440e8051a236 - last_write_checksum: sha1:408aefee9bc68cce3c3db4e294e38543c067e656 - pristine_git_object: f34b265403a4ca4673901441fa467fa4df3f8ba7 + last_write_checksum: sha1:c85fa288fcbd3c4f57ef5b5d59f16985782ca7e4 + pristine_git_object: 4c2680b2f28f87f33313afbe20324b098b35eab0 Codat/Lending/Models/Components/CommerceProduct.cs: id: 086795bae87b - last_write_checksum: sha1:f56ee1d05c6b2509c39509d03796f68938eb8293 - pristine_git_object: 97e9bdd58cdb90ef5fbed68bfed0ad1ae53cc5d1 + last_write_checksum: sha1:187ec332d397d46a35b2faba304dacce3f56be89 + pristine_git_object: a21f428d7537c8c02c56f7d2fe8f1eb7c0959204 Codat/Lending/Models/Components/CommerceProductCategories.cs: id: 54437d88270f - last_write_checksum: sha1:6dc188c37f7ed797e8cb0516f4c3ca8db788550f - pristine_git_object: c996a055212ba4071e75d6c475a6c2980e08e1e9 + last_write_checksum: sha1:06cc2fb1082b9e18daa35d4fcfcf09dbf94d8b18 + pristine_git_object: 3efff1ac985f2317b66f2ef2c0228dce62485207 Codat/Lending/Models/Components/CommerceProductCategory.cs: id: af95e1e663c7 - last_write_checksum: sha1:0e8b670b7172f41c7bbee92214ee1545b67d9f9b - pristine_git_object: ad81afaeae5530aa4c80eebd1f58d7bafa8a9ba4 + last_write_checksum: sha1:d9aee8536d4bc0954f530f2246ac6753f71aa652 + pristine_git_object: a31a1b5d8d528fcd3ffc75081244a60b49581231 Codat/Lending/Models/Components/CommerceProducts.cs: id: cab9caad7aa7 - last_write_checksum: sha1:4549bd737ea903cd284c90e46b9d3cfbff195add - pristine_git_object: e48a4f01508ad27ba81fd2a8efdd324ca53d7ee2 + last_write_checksum: sha1:eed9a6c6eab16bc9c15748e5d98bfa0762077033 + pristine_git_object: 635bfb639af629f2911075206757623ed4fa6ae6 Codat/Lending/Models/Components/CommerceRecordRef.cs: id: 581923b023c8 - last_write_checksum: sha1:47b62f8e3e4b263850b0248b2ef148b2fce3fa84 - pristine_git_object: 6a4014bcf8f94d9824850b8e0264c82e3dc1f3fd + last_write_checksum: sha1:2fc03ba9d46af9863a8c08037e9c8ca4e3086049 + pristine_git_object: 3241d94f29988ca16fd11e80b954e7238c557edd Codat/Lending/Models/Components/CommerceReport.cs: id: 455d860ca553 - last_write_checksum: sha1:c11410ca0aac70bdcaad16a1c2fc8a3cf77d2651 - pristine_git_object: 77bfcf3b1c997aeaa0f1cb71b6c5df0fd3a0685e + last_write_checksum: sha1:b48305b32aeeac9984e3f974ec991492019c3e44 + pristine_git_object: b734a997eaa9ba89d33a74e2a09d45d2221d9b64 Codat/Lending/Models/Components/CommerceReportComponent.cs: id: 578f8589138f - last_write_checksum: sha1:400ddc1af19dfb2db21da2083d3581ac48021ba7 - pristine_git_object: ca06c340a57f1db11b803f5a3aff6fa027a4deb6 + last_write_checksum: sha1:7f538704b3db7837415a8da5e386fd3a88841a76 + pristine_git_object: f236922fa98f08e8d3d57b61156894123827b2e7 Codat/Lending/Models/Components/CommerceReportDimension.cs: id: ee17df878558 - last_write_checksum: sha1:d38be633ffb614bf991fff6a31e0f4613143e306 - pristine_git_object: 3b0b943d177c4a1ba124bb8c40d307123d6a9b8b + last_write_checksum: sha1:e149d26e6b1aaba2ff4a71f9d0abe149d8fc400c + pristine_git_object: 339b3265ab515f9531de5d23e684667670ecef78 Codat/Lending/Models/Components/CommerceReportDimensionItems.cs: id: 75ccf22e9c22 - last_write_checksum: sha1:23b93a91043334fd8f4be42d33def650feb380e5 - pristine_git_object: 3d7a8a98cfab9598e2d9b62df64561d2b9eeefeb + last_write_checksum: sha1:a5ff73d1d2b497e9661d62c0cbb7e219c6f3da97 + pristine_git_object: e37036176a73692aec69928b80f7343b1a9639ba Codat/Lending/Models/Components/CommerceReportError.cs: id: 0890c207abc9 - last_write_checksum: sha1:c478f42ef4f929d5554e30ed92282e5086872aae - pristine_git_object: 0b837e9f92839ac7b5c951cadc9d197ca21ab71a + last_write_checksum: sha1:c3806baeb7db4afeca8fa22755c20a867528a31e + pristine_git_object: b9d395d18794f0d389c40276f8695c6cd22246ae Codat/Lending/Models/Components/CommerceReportMeasure.cs: id: 36ee8de02a72 - last_write_checksum: sha1:9a9cf25dd0014e61cc1c453d6144c3a47527bb82 - pristine_git_object: b3996ca67fcbdd0f6392e0088a6ee0cd7fc82152 + last_write_checksum: sha1:4d2ec0f8dffa198d86a55fead3607d1b98e59f7c + pristine_git_object: c4897f868ddadec28709a136b1ca72a44d4425be Codat/Lending/Models/Components/CommerceTransaction.cs: id: 7fbc842c1981 - last_write_checksum: sha1:3f71ee284ba6873cc0f21a8c2b4843cc95ccac07 - pristine_git_object: 2728fe28d9b69623682b8a55ecd9fd634871e099 + last_write_checksum: sha1:ae01e674d1269a97d77111730688ba634e02a3e2 + pristine_git_object: 911ddc76b4ebd36bbebfc7c6c23e945a38036e4e Codat/Lending/Models/Components/CommerceTransactions.cs: id: 5251f69b9fcc - last_write_checksum: sha1:008d88a97a91311d21786fde0bbe471932299d63 - pristine_git_object: 6fedb4244c0da5eee949a356f2366689d4c2fb53 + last_write_checksum: sha1:42734f527f268cf153ec9fa39e56698cfc2c4571 + pristine_git_object: 47679d1a24c66db918775d6f9f50c2658dbc98f6 Codat/Lending/Models/Components/Companies.cs: id: 8c3ebf106c6d - last_write_checksum: sha1:b7d566b358839fdf0190ad390f697705cbd9e58c - pristine_git_object: 614c80fe439256ab579b42b53265361a17f5fe50 + last_write_checksum: sha1:a9f7b7c325243f91121dc6b5b7e6a61c4b9494f8 + pristine_git_object: 3c77e72203c741e4add6e654937fbe797755acb7 Codat/Lending/Models/Components/Company.cs: id: 398df1987ae0 - last_write_checksum: sha1:21a0bcfe779b7d8333ee62254397d52b36751b5f - pristine_git_object: 575f263d633823181464a4557d63c98b12ac56ba + last_write_checksum: sha1:8fcefef62b7682f413eba2d3e3fd0e6b3cf3a8a6 + pristine_git_object: c2fea1d733248c85303c472b5ba3181f538e6591 Codat/Lending/Models/Components/CompanyReference.cs: id: 9b8fc8c1393b - last_write_checksum: sha1:27f2a0d2a1510cf792077328e96f3f85c5409bae - pristine_git_object: efae7e22a112d18d5560ad3b79e5cf0e8433d899 + last_write_checksum: sha1:7306b6a7581e2e53c3e44794098c34e111560364 + pristine_git_object: 72484d2dfef2e60cb3b7cbb097a909f0ae328625 Codat/Lending/Models/Components/CompanyReferenceLinks.cs: id: 41ee3b7fb598 - last_write_checksum: sha1:ff31ee9aef4220fe947f1fa95d3a5fa38420f1be - pristine_git_object: 982c29f24c98d67fb86ff20328e3d2b590d0962c + last_write_checksum: sha1:884c3e34b0b6e258f313df519a8a71c678cafdd7 + pristine_git_object: 7b6853119fa6a66748cf532d417d2aefad79a050 Codat/Lending/Models/Components/CompanyRequestBody.cs: id: d275cd8b987c - last_write_checksum: sha1:5d76f10f966682dcbbec44ff415b4ed20ed096d1 - pristine_git_object: fee2744196a01e99c9ec2776999da2601d0f9f5c + last_write_checksum: sha1:06086b249fe029dfb0e704122db7ee957defdf30 + pristine_git_object: 370c6ca342b67ef329083cb7d633e991d962ecad Codat/Lending/Models/Components/CompanyUpdateRequest.cs: id: 2cf54f4cd180 - last_write_checksum: sha1:6829e5d44327633fd6feceff32855a45d3e2c745 - pristine_git_object: 282047777bfc58722a6dc46efae6c8a999872230 + last_write_checksum: sha1:528762d6af9c8ba748f6638fb18087122ef14213 + pristine_git_object: 598d3e84df8b5790c72e9255cfd9cf99f482aeaa Codat/Lending/Models/Components/Connection.cs: id: b4b771a64df3 - last_write_checksum: sha1:fc440a0b4d720b493f38a42c452c83c2e393e2b1 - pristine_git_object: a89a28d40273bc99684b5f3f9f72bc9ff431e2f4 + last_write_checksum: sha1:d154dbe3fd81f8c79de59894a4947cb14d7b7c7a + pristine_git_object: 6a329fb2bba86127e3fa9ef7984cc172a7fc3a0b Codat/Lending/Models/Components/Connections.cs: id: ccc9978a53e5 - last_write_checksum: sha1:1346af941e40947c907b564bbede9d87a65703e7 - pristine_git_object: 3a688a51244cfc0f72b681ef3db98186c22dbf75 + last_write_checksum: sha1:ddf40ec28a99140fff332680a773f2169862f681 + pristine_git_object: 69a6796ebe397eb1a86eabc7554aa7bfba2b33ee Codat/Lending/Models/Components/Contact.cs: id: fd88c382cbb0 - last_write_checksum: sha1:806bab21b57960c2002c4f18d2a4460e15755d13 - pristine_git_object: db4adfabacdf37d74979fc26a9cd4881af441d8d + last_write_checksum: sha1:17aa4f4804011068f3f1e45924f4b84599ab2e38 + pristine_git_object: 2066213a96a8c7d503db346407b5ae01727a7756 Codat/Lending/Models/Components/ContactRef.cs: id: 8539cec761c2 - last_write_checksum: sha1:175b1f8f6448ebf5c0f9787eb757111eecf66cba - pristine_git_object: d80d1a7a439743776f8f7665be91cf1ff877f337 + last_write_checksum: sha1:77d00acbff697ba8f19eec2f48177126b2cd6061 + pristine_git_object: 2b83389f6ea39a5f871f34a181fafd1773ae37a4 Codat/Lending/Models/Components/ContactRefDataType.cs: id: 233c5609053f - last_write_checksum: sha1:fe3b69e7d9ffefbfbfa5e5775e03c59b3858e17f - pristine_git_object: b7b336d2752c3e1dc8ac9eac28d9a33e630b1740 + last_write_checksum: sha1:c010b0fbaa858d13273c22cf98b72a98aaac8829 + pristine_git_object: 7866823b881aad85495ef6e513030faf19bcd2dc Codat/Lending/Models/Components/ContactReference.cs: id: f737fb979b55 - last_write_checksum: sha1:431429e30d1a3c8093a5d72a60707bcfe0056bd0 - pristine_git_object: 04e479e4ad4fa46986beeae6faa69572dfbced89 + last_write_checksum: sha1:e96cbfba8df501543de9634f45fa68b465f9f95b + pristine_git_object: 76c007a01036045154187e593fd5d52d6b9615d8 Codat/Lending/Models/Components/CreateBankAccountTransaction.cs: id: 63d6431d9716 - last_write_checksum: sha1:b60fd978cab959de45bc5d0c84cb6be4d2a2e587 - pristine_git_object: c86df30a7dc35194e94879aae241d011c9099a0d + last_write_checksum: sha1:e1a168bfad68bcf0403d1a9cca4abecdbe7b233e + pristine_git_object: 4c2b215616eecc9b16a690d93541ec6fdb8616e3 Codat/Lending/Models/Components/CreditNoteLineItem.cs: id: b582c9c1b5c7 - last_write_checksum: sha1:0f9b0606bbdb6ddd70a1ff1d10a37048f7564a7a - pristine_git_object: 8cc69aaa971ccf3f5841063fa37b9a842145b96b + last_write_checksum: sha1:e56f07e5cf2bef42046fa88124fe3c522e9d7182 + pristine_git_object: b0302602ad7be510d7ee9789b77d64f603c79e2b Codat/Lending/Models/Components/CreditNoteStatus.cs: id: 88c71b92810b - last_write_checksum: sha1:6caa705605a61789a1602130973965bffddebf88 - pristine_git_object: 7c4e38fdab290d347d6c170fc41f243c1c0e8da6 + last_write_checksum: sha1:fe0fb11631bb580a04bdb02ee09290754c683e13 + pristine_git_object: 29e25681f5de9403d3877b8c1b9fb06c06e73f58 Codat/Lending/Models/Components/CustomerStatus.cs: id: 46d8ad99f156 - last_write_checksum: sha1:96fdfa86c83ed9969372eb345abac518854ffe63 - pristine_git_object: cec4a1e6f518df7149f0ff7575e1acc1dbf990b8 + last_write_checksum: sha1:4f9afecaf5c6d4327a01acaaf265eee6a0188f1e + pristine_git_object: 5d82267be0350c773c8f251d26c7a3ebacfc5644 Codat/Lending/Models/Components/DataConnectionError.cs: id: 19003aa16474 - last_write_checksum: sha1:4577160de9521854bfd959862bfa996932e1c534 - pristine_git_object: a5d8d61b2f2fe4d21c38f389701e5969172afd00 + last_write_checksum: sha1:ab695b1d838179aeec2774f5db09d92539cedd22 + pristine_git_object: c83cec075e2e587db64e5bf4f9942ac7e3dc7bc3 Codat/Lending/Models/Components/DataConnectionStatus.cs: id: 7665c6b4a424 - last_write_checksum: sha1:df0c0ec488261b729414154df19d280497af1de4 - pristine_git_object: e3d8ec19a08bd79ad33d74526609167d21608191 + last_write_checksum: sha1:4caa89c28b6f65de3a1101e9de27bddc9126c77d + pristine_git_object: 53bf48dff7139dd38b01ce63e46e07468964271b Codat/Lending/Models/Components/DataIntegrityAmounts.cs: id: 0046e7766d58 - last_write_checksum: sha1:0fc973187280d9fcc69eb85e603582035861c3bc - pristine_git_object: 1749b7d5901d3d7661707fc3a9178a75d9515179 + last_write_checksum: sha1:2add405cb0dc121d2f6b494a817354640d7ada73 + pristine_git_object: 518d62dee9110a7a38cf62e6f8bd77ee8682e9dc Codat/Lending/Models/Components/DataIntegrityByAmount.cs: id: edd1443cb1ce - last_write_checksum: sha1:8d010c9475acd02ad96a65a15773ea4024e85ba8 - pristine_git_object: 9c23bded5ec2b3b4806895fbb464e1ccb8085706 + last_write_checksum: sha1:7fef78ba9a01d3c05a45186d2eddaf908773d7dd + pristine_git_object: 8fcabc846d7c6e2c1f5f06199b1132a0ff18283e Codat/Lending/Models/Components/DataIntegrityByCount.cs: id: 2adbc2771fac - last_write_checksum: sha1:c3e3f05f04011046cb4ae1d31acaa09e1fa97992 - pristine_git_object: 030605b92286d2ea1436466fb9bfca5f9d0966d6 + last_write_checksum: sha1:c7eeb3f4cad872fd3ee41643c0a79fdaff34abb3 + pristine_git_object: aeb78b96264fec5e7087098eebf2bb50370c2311 Codat/Lending/Models/Components/DataIntegrityConnectionId.cs: id: 8ce628624355 - last_write_checksum: sha1:0937b7d5e4594993103db133be3d97eb14350a3a - pristine_git_object: 9756c860f41b45b30d13b85f3836186e3eaf104b + last_write_checksum: sha1:a98a07f00c6513bf11a941f3101d74509a5f7b5f + pristine_git_object: 0257868e3725904f26f287f799530d0c4f8a0314 Codat/Lending/Models/Components/DataIntegrityDataType.cs: id: 8be27b3f62f4 - last_write_checksum: sha1:c9100c94e967124f78f63c143af8d530d494342a - pristine_git_object: 60b6284eb12d95251fc5cb2b92839b7d00b72c1f + last_write_checksum: sha1:56163ba59f6458d365713fc01c8bf6b88378a71a + pristine_git_object: 9d3f4f457d60199a5adafdad62389d655485d3d3 Codat/Lending/Models/Components/DataIntegrityDates.cs: id: 3621229c0fe7 - last_write_checksum: sha1:9071a6f4c640e4e5560a7907de118632e5b6a23f - pristine_git_object: c0a43d49e2227fbb03eae71519b61cab1643a47e + last_write_checksum: sha1:7bd55981b1ea2c8b0a7f3d301da11c0b95c7a7e8 + pristine_git_object: 909b85f856d7bf33f7532c6f853d22ea2ead1f00 Codat/Lending/Models/Components/DataIntegrityDetail.cs: id: 6e0fc9ee6620 - last_write_checksum: sha1:de8da9e90b5105ccea67833292f068df8c2dd541 - pristine_git_object: 2dfaa33b0c326f5cac34f4c35b3f7ebd19b74edd + last_write_checksum: sha1:7021f13e129195447c8e0456a2b02c7b284f4129 + pristine_git_object: 72ba17207277fb7864f7e484504586c8cd136fba Codat/Lending/Models/Components/DataIntegrityDetails.cs: id: 53accf78b59a - last_write_checksum: sha1:edc3a44bccc2bd080f5956336b2f5f4e6af50193 - pristine_git_object: cbcfaffc23ba05abf0a47cd51c1f88d892e88f06 + last_write_checksum: sha1:22dc203eaf4a4906d60bb68fbf98a34ee871e770 + pristine_git_object: df76c7ec2feccfe20926c2c8735d4d673908ca59 Codat/Lending/Models/Components/DataIntegrityMatch.cs: id: ba8a1e91cd09 - last_write_checksum: sha1:2a85b9a8d5cefdcd01efa941c1bb5722936c0a7c - pristine_git_object: b4f6811af6179ae78d78f7f272a508b19350ec68 + last_write_checksum: sha1:25659e25cddf803d65a1f1c83edce3d80d238428 + pristine_git_object: aceff2d6c013c82ccb3997391bd1db5dd66ef4c3 Codat/Lending/Models/Components/DataIntegrityStatus.cs: id: 7969d6671bae - last_write_checksum: sha1:c9906e9ed0f6dea4ffefb92f5ad4c475945aa02a - pristine_git_object: 2df1ebd0085c3d2b40329bc5a4887fea726a7663 + last_write_checksum: sha1:45d27fba80c0f3278221d7612c79f3985c6c4c55 + pristine_git_object: 9b39a5fa4c7ecc9e5abfb985cd3e79acccf6a13d Codat/Lending/Models/Components/DataIntegrityStatusInfo.cs: id: d698fe9ae295 - last_write_checksum: sha1:b95b51e61d83713a13a09c9446b0a9f1d18bbf1c - pristine_git_object: e2db6f541c3f7d6c9b057073be50b6706f5c7899 + last_write_checksum: sha1:969d34ff0d4896ac20305e45d7b91d91c2f4cb74 + pristine_git_object: 5ea1f6c9650b276bf7c6873f185491bf19b479e1 Codat/Lending/Models/Components/DataIntegrityStatuses.cs: id: 68ecd5804fce - last_write_checksum: sha1:bfb749871b0e88e1ff6e8a424affd955425d5ca8 - pristine_git_object: 657d24ffc75807048966bce3bf4446d64be1218e + last_write_checksum: sha1:b4484de22bb0f6b809920125dbb73e248867fbad + pristine_git_object: 38fb28582e0c685dc417d6fd7914bd3485b39d3f Codat/Lending/Models/Components/DataIntegritySummaries.cs: id: 65e1ee936708 - last_write_checksum: sha1:af75ee359464a6f8fb7e4caeb698e58de991d4df - pristine_git_object: 22dd8de10298e05d9b7ca1211439e3842676b7fa + last_write_checksum: sha1:34e10ee032096b77973e36af8b3f52aa370d53e8 + pristine_git_object: 38cd977aa018dae8f0fe642c3f2440e484c75266 Codat/Lending/Models/Components/DataIntegritySummary.cs: id: 5ba6b8df380c - last_write_checksum: sha1:a3a9cf02deff89a6fc9b9994da49b6d8bc925898 - pristine_git_object: 0c88df82397e74b5432b6c52d5949d7c2395bc8a + last_write_checksum: sha1:884a1acc044d65912e0c752b2b89ce7c84f820ae + pristine_git_object: 3b1bbf133f18fbc4b630252bf15d1268cec88757 Codat/Lending/Models/Components/DataSource.cs: id: 64876c978f57 - last_write_checksum: sha1:a98e3e4ffa56492a9ebe305f4855431ffb021f6d - pristine_git_object: 12eb74bd9ff29e291ef34f2a2c45204385e218eb + last_write_checksum: sha1:236b5a4216d9433ab6bc7cf330f3ad61933c87ae + pristine_git_object: 586077db0d116bc50e1978e81e1536279da7be5f Codat/Lending/Models/Components/DataStatus.cs: id: 249f619e7738 - last_write_checksum: sha1:1f750ed7369c830dd0d56203f96ea62b541cbc66 - pristine_git_object: 561e8a708fcc4aa573b7b1c6d62f01739ddac038 + last_write_checksum: sha1:bf53b8517b854faec97ebd61669cb0dba4558a79 + pristine_git_object: 6936b07aaab7f9fc6c50a3aecf0c0c2acb0bc12b Codat/Lending/Models/Components/DataType.cs: id: 3b7d32d79170 - last_write_checksum: sha1:9b4144182aa3b1dc26401c957eafede8cbc09789 - pristine_git_object: 973f471e32ec2441d58e2d96c2d432cf55aff06d + last_write_checksum: sha1:86e558f37e6bd38cbc23380914c162c82aa33c2b + pristine_git_object: 9d5826dae1283009eaff5ae2675e7a4f80e84b75 Codat/Lending/Models/Components/DataTypes.cs: id: 446693aa40a3 - last_write_checksum: sha1:332c54fee4f30261c049b6018ad1cb3a0e2035ba - pristine_git_object: 33a7918d84ddc4cf313129ca9a5664ce6c9b87d0 + last_write_checksum: sha1:189d8f30e9679571f8e52e63993ef747a7311a29 + pristine_git_object: 80c0493f448ef7155b654de42996ad4d9e752eb8 Codat/Lending/Models/Components/DatasetStatus.cs: id: 4588cd640e0e - last_write_checksum: sha1:a911d5ef230844dab0537356d4a552d2d5863a85 - pristine_git_object: 15a0d26577bf3f249bff3ae8487542d9bb093698 + last_write_checksum: sha1:f2e1039452a9231d99810aba1626efd0c9c6a980 + pristine_git_object: 6d148f752aa99470d255a63bc64f777f5c746f73 Codat/Lending/Models/Components/DirectCostLineItem.cs: id: 562abf263cce - last_write_checksum: sha1:8a2683f1ec8761addf291cb5e04448e72dba2b0a - pristine_git_object: 91befa56cb52f2bb9f2fae289befaa4e6823b6f8 + last_write_checksum: sha1:2402053c12209b4b76045ea25069633ee5762813 + pristine_git_object: 48fcd8bcb8551129ed3a9b472f2e5c30e48e754f Codat/Lending/Models/Components/DirectCostPrototype.cs: id: 6ee256ca6e3a - last_write_checksum: sha1:17aa29bafb993d36b7469966beb855637390cfd2 - pristine_git_object: 0b29a116f08dd5be2e9445cc2e23627fc10033d0 + last_write_checksum: sha1:01e7a060e409b63edfdab8ff5fa45406774379e7 + pristine_git_object: c6d137be606be68e2da84b5f28136362a105909b Codat/Lending/Models/Components/DirectIncomeLineItem.cs: id: 802871b54c64 - last_write_checksum: sha1:438d30d097d6ea2215026fa88321a6cfa565c1a6 - pristine_git_object: a619c00d5832cf24c1e32db06bdad52a9d3cbd30 + last_write_checksum: sha1:05905ac9683eb18db15cac926c22d4ab77441602 + pristine_git_object: 3bab86fd24532cecf2b2688e2caff8c7cf4b4ea8 Codat/Lending/Models/Components/DisputeStatus.cs: id: 0c08b2913121 - last_write_checksum: sha1:11b20e8ba19dce12dee8dce36690f5a179b6d9ab - pristine_git_object: 43b8ad4f4ecc41c3bf677d8610c07eb3f54b8144 + last_write_checksum: sha1:f90d5dca8b9e42beda1b34aa5d6d74894b429636 + pristine_git_object: 70ba009252b1fb12fb67893ef171e2478289b657 Codat/Lending/Models/Components/EndUploadSessionRequest.cs: id: 96daae8d2e27 - last_write_checksum: sha1:a4c50265789874320fb514d353a706bd442d9357 - pristine_git_object: 93f74aaa05b0dab20eda5c54511462c605c135df + last_write_checksum: sha1:793df0d56d73a9b69c6d4e8c6387386a50917dee + pristine_git_object: e4284d8520e02d88a4d513c0946004cfc56ae594 Codat/Lending/Models/Components/EndUploadSessionRequestStatus.cs: id: 02a452a0d972 - last_write_checksum: sha1:aa68452f4b763c4424c930368ccec86eba834341 - pristine_git_object: cc0c34edc1f216fe5345a395c7f05e1cfa249b67 + last_write_checksum: sha1:cde900f24ba06771278d7a6b471450c5721c8e99 + pristine_git_object: 0a98f76222562d32195323c32a3205c61e859475 Codat/Lending/Models/Components/EnhancedCashFlowItem.cs: id: 3ac19dd6f1cc - last_write_checksum: sha1:16fd99dad233bb00cfda88a97cc683ecd2810d6b - pristine_git_object: df84c6b640c1c12f3616aa9ea78fa742c217d1d9 + last_write_checksum: sha1:79225a7c23602dd495800578aadac4d640492766 + pristine_git_object: 516aa1ccc6caf5bb8e3766a1f4cd74e1e3fdd707 Codat/Lending/Models/Components/EnhancedCashFlowTransactions.cs: id: e3bc1ef81994 - last_write_checksum: sha1:013aaaf629680db10eab88127949aca78ddd8a57 - pristine_git_object: a100a6f515f971270441eca704751a13c90131b8 + last_write_checksum: sha1:4ee0ee71ebd325ee075f4b884c39ecd7e266f64f + pristine_git_object: c39f6ff7c5e17aec9b54bc6a193c2ff1c458254a Codat/Lending/Models/Components/EnhancedFinancialReport.cs: id: 6406b5686286 - last_write_checksum: sha1:b5303b31900ce0e1240a964c296a318bbaa10f5e - pristine_git_object: 5ef64f1acb2c1abd85eea34679e98223539a6d34 + last_write_checksum: sha1:cee85d6555791bcf6b159b97ebf8a9c958b26077 + pristine_git_object: 06ac17247fa1d4199a0d826510161554d3507b26 Codat/Lending/Models/Components/EnhancedInvoiceReportItem.cs: id: a8d3e347e8e4 - last_write_checksum: sha1:6b95627971030c3b013d71d876a9ba47334c8337 - pristine_git_object: 5cdd4d71c625701d7733e5ce4707e2394191acef + last_write_checksum: sha1:6aab55d73296294554895aa6e504ea19f5ae2827 + pristine_git_object: f496e73773ebdb68c7b1b69407ad83b8bd3e5666 Codat/Lending/Models/Components/EnhancedInvoicesReport.cs: id: 8a6cdb8cdcf4 - last_write_checksum: sha1:43aea9bc1c74371cf6be407de45c6f7bb72af49c - pristine_git_object: afdb3ad3d476237c21f658adfec65f848e83d5ed + last_write_checksum: sha1:26e53495d63b87eab833ff7f32ae4435ac50f09a + pristine_git_object: ae543a05b480f5c959bc15a6cde7381dfa51a989 Codat/Lending/Models/Components/EnhancedReportAccountCategory.cs: id: aed6e0f56c0f - last_write_checksum: sha1:12fee391e12c75d1dd61d46108dc0db2276ff055 - pristine_git_object: 3a56179de7df016462248bbab50e728bc87235b2 + last_write_checksum: sha1:453ad369ae5bd3fbc4b1183baffd8162f4050b0f + pristine_git_object: fcbc3c3c84cd8dff237e4353ca3a90c49dbbb3e3 Codat/Lending/Models/Components/EnhancedReportInfo.cs: id: 1d70549fe589 - last_write_checksum: sha1:b284049d17eec1f2baf732a40764d375979eb663 - pristine_git_object: be23f0e5dc1d9c26cc3787c118ee207d482bd7a8 + last_write_checksum: sha1:1d7aee8587ba1574cb2212dca4403265756573b7 + pristine_git_object: edccd6058bc266814b9a615337ccc357c2506c12 Codat/Lending/Models/Components/ErrorStatus.cs: id: 6f18aaea3ebe - last_write_checksum: sha1:30c67642257127af0e3703b896e6cab233771108 - pristine_git_object: 5a32bfa67c9e79c115582f015d82c58b3e14fdbf + last_write_checksum: sha1:fcd1573989546ca981723e0971ebd07c70a51ed1 + pristine_git_object: 5ef08f6b4cf34af25d85a7405d8f668e85a04360 Codat/Lending/Models/Components/ErrorValidation.cs: id: c3794b198135 - last_write_checksum: sha1:c80c64742387324b3d2179d6ac2b641d303dacb1 - pristine_git_object: d0e29f20c9cf64678bf5c7f00e9f7b648c30428d + last_write_checksum: sha1:431741a54cc96314f5b151a7b59a9fd8f43f5b2b + pristine_git_object: db67c55ce802ce8369855234534db0c386f26ba0 Codat/Lending/Models/Components/ErrorValidationItem.cs: id: 4af67705a568 - last_write_checksum: sha1:26024857fffa9ad697caa7ebba0e6d1e42a6ce7e - pristine_git_object: 9e8758327b3aa444b8e49b9a138a5d91afd29f53 + last_write_checksum: sha1:5532d4a50b76f66d3fc06fd14e50ae065e3c6afb + pristine_git_object: 204208caefba3688c8b52a0e0d90f9f95ea4c0b8 Codat/Lending/Models/Components/ExcelReportTypes.cs: id: f65b6d7d2735 - last_write_checksum: sha1:6fffd3f1e4c56474274739e47dee5add962fb441 - pristine_git_object: 6264dde688719562c232beb37536d6bb1a4f3cc0 + last_write_checksum: sha1:169b3b57fa28f74626d7806be0d4f7372024eb16 + pristine_git_object: 802e0abe247080fc4fba118c18e244a4a2b3885f Codat/Lending/Models/Components/ExcelStatus.cs: id: 0963174fd0c7 - last_write_checksum: sha1:cc21d7d443fb550fa93a9f43f7d5a60a3315f170 - pristine_git_object: 3e230bccf760b6d0348572e4440c97d44f699585 + last_write_checksum: sha1:9e34089dc4c83ba91a902a2ed3548791654143ef + pristine_git_object: a94a795027073b29d12096b2f339cbd3502b4e02 Codat/Lending/Models/Components/File.cs: id: 83629c9a727a - last_write_checksum: sha1:daffb521d565cc3c6f590e46addaf8751252e314 - pristine_git_object: a81b3ddb212e4dbdc7a98edb525a4d5b972619d7 + last_write_checksum: sha1:8ac4f69f237636d8b83a903190e501d4ec0a1fa4 + pristine_git_object: f063e4fceac1300873551d5b9d3836fb8a49a1db Codat/Lending/Models/Components/FileUpload.cs: id: d8f10655e937 - last_write_checksum: sha1:786b160e714ad49ef342b426645088f8de51da53 - pristine_git_object: f23f3c68f8e505acfc97fd2323460c6ccbcb95bc + last_write_checksum: sha1:3f039f0fef79f6b9aef6c79ca37ab410542a0d91 + pristine_git_object: 018ca1493eb6f0429f56a8aeadd4997abeb4d3bf Codat/Lending/Models/Components/HalRef.cs: id: 8a267d36a345 - last_write_checksum: sha1:f07806e5d3ca25310276e76f861368af922147b8 - pristine_git_object: 29b73d3e448073b9df44e8bc1bbc849a489ef216 + last_write_checksum: sha1:0792cbc6f32a21b9cb0a1a1506fc947dd40220b2 + pristine_git_object: e06ead838acdfa0e74994a578a3463691f2276c3 Codat/Lending/Models/Components/IntegrityStatus.cs: id: 3270ba128c64 - last_write_checksum: sha1:2d3c8688c0e47447fd8454d83bed6321c4a20d79 - pristine_git_object: 92cd5fd7fef68c8a1996f2a2d3129d9c84710c88 + last_write_checksum: sha1:27fc752ce5657b72289d00cc9e9c3cd5bb475be5 + pristine_git_object: b107568cb8c20503ad73e7035a5d73f9a3547d89 Codat/Lending/Models/Components/InvoiceLineItem.cs: id: cf8b69965a36 - last_write_checksum: sha1:b5ba814742cc1f1b652667ce2e7f04bea68ffd11 - pristine_git_object: 8dbc4228926556bbd30259893f3d984d3c1050b8 + last_write_checksum: sha1:2aa2050b1157433827a6ddfb5b53160647f44e9e + pristine_git_object: efd56530bfeda94ba3db30d6dc719de16d791ad2 Codat/Lending/Models/Components/InvoiceStatus.cs: id: d987b16472fc - last_write_checksum: sha1:dab1910aa18c65e9711bc0a65a6f6fe343e4eb54 - pristine_git_object: c938f285001e729a989acb30b4d469ebc7079c29 + last_write_checksum: sha1:9e168664c6d2e1c864c734944581ac49b56f31f4 + pristine_git_object: ae349dbcf44ff551dc4d5eda58af2f55099259a4 Codat/Lending/Models/Components/ItemRef.cs: id: 11bf7c313a56 - last_write_checksum: sha1:89ec3d3d877e5f7342030b51c3453831d6454868 - pristine_git_object: bd52ef191ed36ba71385c91fb00fcefbe7c641b6 + last_write_checksum: sha1:f9aa20fbae7dabbab3e0a3a8a4dfaca37f1e7669 + pristine_git_object: a79c6d237d8df649265a103052e9f9d2df1f4cca Codat/Lending/Models/Components/ItemReference.cs: id: d0be43aed684 - last_write_checksum: sha1:ff3098706775b6594347d162ce4f0d07a29e9cd1 - pristine_git_object: 05af3cf07ac62a3a43bf1eb44fff347b771d7fd8 + last_write_checksum: sha1:07a62e410f49d6c7788b7871d52caf2fed475ee5 + pristine_git_object: 86778989c46d353bd1e8778728fe56443a7cae32 Codat/Lending/Models/Components/Items.cs: id: d67e52c7ef41 - last_write_checksum: sha1:96c8ccd61da05bc4a9fe6b03a540fbd22e124b7e - pristine_git_object: d428010c3896ebaf1b04628aa700c71e532b04ce + last_write_checksum: sha1:7411aca1345f13d56a495c2b26a2bccc7de447e8 + pristine_git_object: 3f515e241f2a8ace4942161af1d403bb580e517a Codat/Lending/Models/Components/JournalEntryRecordRef.cs: id: b9f10b74a77c - last_write_checksum: sha1:68390e1bc0dc2bb31da5f648d283e785633ab409 - pristine_git_object: 84468a2de6a69e488d656bab0e2f6d51aaaf2c72 + last_write_checksum: sha1:bbdcb4f97912586b22bbca1a5a5a39f62cbf1c38 + pristine_git_object: 61f60da4c2cb4532eb5c189b9a67e4f76c753779 Codat/Lending/Models/Components/JournalEntryRecordRefDataType.cs: id: 87c05f3156e3 - last_write_checksum: sha1:b7bb855876c96d06a5b7c5297686c5d3d39c5aad - pristine_git_object: 75f42b19021c530bf434f99bae70024e6017ed89 + last_write_checksum: sha1:e61657b58bd35fb4b61ff7e6ca1d86b9c1259b22 + pristine_git_object: 07ef10ba6d5f375f0f9de801b9dffbf82dab9890 Codat/Lending/Models/Components/JournalLine.cs: id: eadc5ae243e7 - last_write_checksum: sha1:b17e2a58088bf8e115ea9e3f57bc947fc1130d06 - pristine_git_object: c69f9b083397541870252cce080367b4879992c0 + last_write_checksum: sha1:17502533b04630d20672be359e5b498cda1f46ff + pristine_git_object: b91480b814b0fcc85bbd43842cd9fb8aa7c34c0d Codat/Lending/Models/Components/JournalLineDataType.cs: id: f9256271f954 - last_write_checksum: sha1:965070f3d597d5f98b5d98f6ec3598ac5cded67d - pristine_git_object: d9bbfd1cfb7dde49591495c644f8751be41cd426 + last_write_checksum: sha1:a1734783c1d4c83781dfee8d2c24d552472e50d7 + pristine_git_object: 7f00cfe7318a2999c9cafa0d6d12c07727e138cc Codat/Lending/Models/Components/JournalLineTracking.cs: id: 2a3b77809e9e - last_write_checksum: sha1:4bcc2f84c3252b38ce46b35151aba5d0b5f0d69d - pristine_git_object: aad34228792f79a26f4b37a129751853c9b39449 + last_write_checksum: sha1:1ebe7e58f0ec14f29a77861d4f77a663cc97a3fb + pristine_git_object: 22472ccace759c0b69edadb35e9a2625959f8360 Codat/Lending/Models/Components/JournalRef.cs: id: 6ad8d668ecee - last_write_checksum: sha1:04284a3a9e635876668ccc534c6cfdd9b6829014 - pristine_git_object: 21773690767ae7221df6736c40471743820390eb + last_write_checksum: sha1:0e6e85af00ce2be3a0a8df511aff0ad422fc28fc + pristine_git_object: 86fd1345a74ff53833e0338ae2c6c40bc5612456 Codat/Lending/Models/Components/JournalStatus.cs: id: 930ee4597a2c - last_write_checksum: sha1:99e166832de5b201b0ee1c112870da6fab50d9a9 - pristine_git_object: 147c2b779b14a32e0a70336b11dc15dbfced8717 + last_write_checksum: sha1:62def51d0422c80335ef55bcb4d565c3e645d24b + pristine_git_object: ab001d8e490642d9baa850cf13bee3b746d6fa2e Codat/Lending/Models/Components/LendingCustomerRef.cs: id: 78bb2c4a6d43 - last_write_checksum: sha1:9113d0028b39c55bf7bbc4ac9c75489d16f67eac - pristine_git_object: a6ff3fc02d59d5f7c9c2823aa887389740d699ff + last_write_checksum: sha1:8ffa0b00851a26dc54c9734b012bd0c5644a11fa + pristine_git_object: 019c53ce8939763b560436e99502e82eb2bd2dd4 Codat/Lending/Models/Components/Links.cs: id: 4a543b55f91b - last_write_checksum: sha1:e20756b2547ecea31ccd5658d434d6357da3756b - pristine_git_object: ef249ad8d084cdc01de28fc47523900d31eb45f0 + last_write_checksum: sha1:6e9960c856e75382b8b334ff0f04bfa8112f76bd + pristine_git_object: 2c28a1a1095857b2ec1089d596851c7b9a5ca3a7 Codat/Lending/Models/Components/LoanRef.cs: id: f631da20bb9b - last_write_checksum: sha1:2e978e7d3c06eb32141e5079a204a53d11264fef - pristine_git_object: c1eef36a53d4d6b789647b14aca771b3f89ae492 + last_write_checksum: sha1:9c17a0443935632fff36e0c4514aa17e820f1243 + pristine_git_object: 46e2f4a0213a8154a3472b4be5fab2c7240a04f4 Codat/Lending/Models/Components/LoanSummary.cs: id: 136af659f6ac - last_write_checksum: sha1:a0401acb25893a2b1aa8a4fdc34e37cfae943411 - pristine_git_object: 05672931ee2d6e0f12c165c211c14c0e79e3230c + last_write_checksum: sha1:a7bd958f844364f13e4904aafdde88efebaffdb1 + pristine_git_object: 3ac9162c7e2bfa88808741ba0885b1ca38ced3a3 Codat/Lending/Models/Components/LoanSummaryIntegrationType.cs: id: ffb03f08e6c1 - last_write_checksum: sha1:fdc18410ecc0401f999fcd73769fe2480161a625 - pristine_git_object: f86573f0aa9c738a9060de015224cd4fa1f8792e + last_write_checksum: sha1:c20fc0a82f043f5e1d3006927d3a8eee8c8c5da7 + pristine_git_object: 740d42a1e806dfce6531761e261e7e661049a2e5 Codat/Lending/Models/Components/LoanSummaryRecordRef.cs: id: f74edf974985 - last_write_checksum: sha1:e1e277a17e1a13354da53fdf92f38e38f157ec33 - pristine_git_object: c59ad936f9178d92144e89a308d1b914f88150f2 + last_write_checksum: sha1:66528c52a66267b65f8a7f847d82ff488947f430 + pristine_git_object: 1e3869678e7c9a95cf5c79edcaeaf525126da463 Codat/Lending/Models/Components/LoanSummaryRecordRefType.cs: id: 61051d05a31f - last_write_checksum: sha1:ce39d59373f49043640231f0a8fa99b7f1712350 - pristine_git_object: 79e1c225a4d4c2e7583e175fafd346a787a5302e + last_write_checksum: sha1:31815bf6826ebd89b33ac91d3d1dbf9bb663e55c + pristine_git_object: 235bf0369b5c374b94b5c73c3d57b4599d2100a6 Codat/Lending/Models/Components/LoanSummaryReportInfo.cs: id: 3ae06ea5b79a - last_write_checksum: sha1:3173c02003907d4b18dc5a439ce40b13306d880d - pristine_git_object: b5a0e8f5ddd673d8cfaf534efc0e305157f10fd5 + last_write_checksum: sha1:93dab8c9bf042600fe36c684f0b897862b677b99 + pristine_git_object: dbc21c3cbcb2843944aabe41df30e23204103fd6 Codat/Lending/Models/Components/LoanSummaryReportItem.cs: id: efcbce8f72e7 - last_write_checksum: sha1:8847ccf76209d28828c971e722e8cc9a36f70d95 - pristine_git_object: 9dde261624c0883794c9caf9cf69a44a4d0274a1 + last_write_checksum: sha1:1b86bded00a8635063abaca85c5e5dc9b9c0ce55 + pristine_git_object: 6fab4a85f7afb06d6fa2f93cc938ee45081df75e Codat/Lending/Models/Components/LoanTransactionType.cs: id: e3d040533767 - last_write_checksum: sha1:f1178d390169aa8a9102554d9f9dd390a004f6ca - pristine_git_object: 29389e25e2050c8b9f7a7a64892251d6a76f501a + last_write_checksum: sha1:4b5f44767b33ec1e8c28ea9c7c2ca9c5703ff71b + pristine_git_object: f5a7985429e839206c1be309b08f8309c82816c8 Codat/Lending/Models/Components/LoanTransactions.cs: id: 94fbe4eedd53 - last_write_checksum: sha1:30a44d350a6a81c7a9d6b9a345d9fa8ba74d9271 - pristine_git_object: ad4e2d8e61fc75bc16bba373e92d22b7983fd924 + last_write_checksum: sha1:d0f5fc0f59efd8441af65cd65fbf64cf5262b2d9 + pristine_git_object: 97c6ee7038d3d1a82b5503172d68714f5e974e61 Codat/Lending/Models/Components/LoanTransactionsReportInfo.cs: id: ac969a7fe921 - last_write_checksum: sha1:dfe23005bfb9ec80a9a0732344437f87d06dd132 - pristine_git_object: bf8b886ce909f4226209eda136ff7caea37da4f4 + last_write_checksum: sha1:19d57a6f1b22ee499284b7f6b652c3b1c91cfaff + pristine_git_object: 61c660a4256561a1cfad342109a2cb0ecfcd115d Codat/Lending/Models/Components/LocationRef.cs: id: bed5525b02a6 - last_write_checksum: sha1:89fd9d9bcdeefb077369e7c907b63fb6259a058e - pristine_git_object: aab38b78f6a84e2eb47148d08b7bc4705e89ebdb + last_write_checksum: sha1:53752112cdf7599fb6027fa633ac4720eff4a5ae + pristine_git_object: b8f7a8bed9bf853c8cad404686e6874e9edb1ba9 Codat/Lending/Models/Components/Metadata.cs: id: 409285c220f0 - last_write_checksum: sha1:b02b264ea9b701bebf555687d8ef6ade6c9c72a2 - pristine_git_object: 17bd28e0dc906d5b3ebe6bbea008fff24d7ed71f + last_write_checksum: sha1:f1f2406a771d47135bc4d09a5d582ba9e3e4f87a + pristine_git_object: ef4232f18e55f7397001e59181c3227516a10504 Codat/Lending/Models/Components/OrderDiscountAllocation.cs: id: a6b6539ab669 - last_write_checksum: sha1:628f3f97e23f1f3836726fca2094af36a2e8cd36 - pristine_git_object: 38ec2787eb1c12f10e5692afb5690d57aee0216a + last_write_checksum: sha1:580be7006a75e6e14bad5d2372ff77fd5976ced5 + pristine_git_object: 67a0aa93b99a9e26133a6986820dc6d8d69a7f3c Codat/Lending/Models/Components/OrderLineItem.cs: id: 54461cdaa652 - last_write_checksum: sha1:e1033b88528b4d31aa30e08d44c2ccf7f5708ce0 - pristine_git_object: 53024f1b220f7aad2195f3611876a00fca83447a + last_write_checksum: sha1:f17a22165b92baccdf13d457cfaf3e28a318c9f2 + pristine_git_object: 4a79acc85efe9800cc3d11f02d2299b032389575 Codat/Lending/Models/Components/Path.cs: id: 4a41613585a3 - last_write_checksum: sha1:9331ee23ba08adbde31694d1ecff0901ebd23f05 - pristine_git_object: dbc601c592b68e6bf9593efc4c1d1b2efb510753 + last_write_checksum: sha1:9a32dddf796996941cf459291a44a4166f9f26c0 + pristine_git_object: c9a17a02d7dfedfdcafb4882a8445d1fc86efd52 Codat/Lending/Models/Components/Payment.cs: id: 41fe3c74709d - last_write_checksum: sha1:ac3395d36e3ae5367595be8c12976b57d4a0aa5e - pristine_git_object: 653133b9f8d633ab4a16ceb7466c739c4469914a + last_write_checksum: sha1:ffc514635ec7bfd36c3bc2022f85a708c76a023e + pristine_git_object: 326f93a4fb3af473c5357b4cf24554dd81ad7185 Codat/Lending/Models/Components/PaymentAllocationPayment.cs: id: c55e0feaf322 - last_write_checksum: sha1:aee3ba8f05f9e4dd94a391be4894425b10bcefd0 - pristine_git_object: b696bc412c0478535939e4c4757952195cfb4ffe + last_write_checksum: sha1:909753bf8f48013cf4377192279eac9cd85c9e4f + pristine_git_object: 8e4d5aa414c4fd814ef6d63c3bc8168b9f23da3b Codat/Lending/Models/Components/PaymentLine.cs: id: 6027435c81f8 - last_write_checksum: sha1:4f7a45533f625ec5a709ff1934208c91d71bcfc1 - pristine_git_object: f91316172ab8c3870aa2bbad33cd02dfa0c4e572 + last_write_checksum: sha1:9b342ef21c917bee67cda96946b6d02feb6e3df7 + pristine_git_object: 1934deb84024a06a88149228baad12bec6aacb47 Codat/Lending/Models/Components/PaymentLineLink.cs: id: e93282dc5b8c - last_write_checksum: sha1:d8615993b9d5ee131341858b913ca05b39a289b3 - pristine_git_object: e6e8863ecd5e92dc71b454ac5cc8ca34c318343c + last_write_checksum: sha1:d858f4607e6552c54a4f0630478cd5f9707b63fb + pristine_git_object: be6113fcc5aca6c6cf81a66df7fac72b0be3f7bc Codat/Lending/Models/Components/PaymentLinkType.cs: id: 219759b176c7 - last_write_checksum: sha1:8a77a4831f44ff9a148025265406f35a05828ce0 - pristine_git_object: 7bc64119f48d5f885415dd34f923f430c8f4cba2 + last_write_checksum: sha1:e1f0a8dd77a54a8044174d3dbedf984278455908 + pristine_git_object: eb23d4403a908b4c8adfa1b9e2a4f827e905ed5c Codat/Lending/Models/Components/PaymentMethodRef.cs: id: a08a7746af9e - last_write_checksum: sha1:c1edadfc03fedd744b153f47eb5bbfe90f426417 - pristine_git_object: 94ae5fd239347581c8df4d3ff568d57115af2c7e + last_write_checksum: sha1:73f05ed0a3b82bae3e2c49338d9b761910b26d15 + pristine_git_object: 5d16225ef83f8878ef610c602cd32c637cb52d81 Codat/Lending/Models/Components/PaymentRef.cs: id: ff6193217817 - last_write_checksum: sha1:fdecf56b286549ed181bca71d1714ecee4e6c0e2 - pristine_git_object: 189aa746a05ed27f1d4343e22df19a82278fcb48 + last_write_checksum: sha1:5c843129cb6a7b9f2b6921d439211615e5532277 + pristine_git_object: f136cb30029a0cad72d0c34dfa456888007111d6 Codat/Lending/Models/Components/PaymentStatus.cs: id: af2d5e668acd - last_write_checksum: sha1:7d59adb34121b36d44e36e6133f0d171a9fde724 - pristine_git_object: 0e17b5a610bbee79a26f01e0228acdf29c8ff76f + last_write_checksum: sha1:6be4644fc8c8522c169d0e69afb4879777d88097 + pristine_git_object: bee70fbeb2591c71c1c9cfd184077501a895b3bb Codat/Lending/Models/Components/PaymentType.cs: id: 0a52915c9c82 - last_write_checksum: sha1:246cf5f47522acf3532515e1ce5f61600cc378ac - pristine_git_object: d85e79e765053efcea3de34f150f7b490459eb11 + last_write_checksum: sha1:1889092fcb30ccfbcc55da9041fb13b4eeb94d30 + pristine_git_object: e592454bc1fbf684708edd3331afc7ef4e4e849d Codat/Lending/Models/Components/PeriodUnit.cs: id: 4748d09682ec - last_write_checksum: sha1:ab15dacdce3c6866c5786503978772fc0ca5cd93 - pristine_git_object: 20e662ab0a0514ecd19c6e96f4c1278a5d153eb6 + last_write_checksum: sha1:b55b404c6bd55aefab0ac2f0b07a19fb09547b72 + pristine_git_object: fb846cf73640878f26322ae4ced22401fe1cf323 Codat/Lending/Models/Components/PhoneNumber.cs: id: 36120dec9ba6 - last_write_checksum: sha1:64a9c5dc65b6c583ce75e50aa23df4907764044d - pristine_git_object: c82f8b991c88461682741186d8cf81c43318fa4c + last_write_checksum: sha1:69111eaa9682b0857bdb1a395c0a73d2cc6661c5 + pristine_git_object: 8dc6001abe9319e06ba34dc228bde57d127c0a65 Codat/Lending/Models/Components/ProductInventory.cs: id: 86d669904bfc - last_write_checksum: sha1:1d603d966c1b73006178dbceced762e4909ffb08 - pristine_git_object: a800f006b76354db937a46c2e7a91124d44c39c3 + last_write_checksum: sha1:dd8bcbced48a3699b26cbdf93bdf27a9d2216708 + pristine_git_object: 551180860006e7c25f8a320e2146ee48db51c8d1 Codat/Lending/Models/Components/ProductInventoryLocation.cs: id: 41273fd06441 - last_write_checksum: sha1:7f9900f7964ef5f2ebada2a2aa8c0dfd8b38ed5b - pristine_git_object: 0ffa519763ac567bdaefdb023775d061e57e06c8 + last_write_checksum: sha1:6bbea649fd23bb0e161fe88f2404e546a68386be + pristine_git_object: fc45e589b7629b7d6a654e73baa9b43eacf0dfc9 Codat/Lending/Models/Components/ProductPrice.cs: id: 9d0f589b06e9 - last_write_checksum: sha1:c2cfeeecdd95e1f372d39ac4d7f8c43aeb871a12 - pristine_git_object: 8a860b93b48536829a7ab347ce57e5adae063fa4 + last_write_checksum: sha1:5244bc4e04f1d04c73ffb62105d824cacf073574 + pristine_git_object: c51ae16044268e0545f3c883abe481ba827f30c4 Codat/Lending/Models/Components/ProductRef.cs: id: 169668f2e957 - last_write_checksum: sha1:c5c69778ae72937a04d4bd7bd05793635f55e1e6 - pristine_git_object: 40813eed21463cffeabbb35a42949b254e4003fe + last_write_checksum: sha1:64548e1392e6ceb7f39aab1ef6139c8a9e3c6654 + pristine_git_object: 8504f3bb273364ab267b96d3187d00523404652b Codat/Lending/Models/Components/ProductVariant.cs: id: 4771f025e1f3 - last_write_checksum: sha1:2d6d28aacc58f5651d8ae11b55dd710eac44d87f - pristine_git_object: 52086cb030a9c0ee753711f7c7a06f77aada8c9a + last_write_checksum: sha1:68e00aa8c148879f478880db769cb7899ae8e6c1 + pristine_git_object: 8b825558029d02c62279ec78e4096143e67d71d0 Codat/Lending/Models/Components/ProductVariantRef.cs: id: 45134eb3f6b7 - last_write_checksum: sha1:a68407d52134d7c52f93e0cd07bc65fdc40c0011 - pristine_git_object: bf9abbc6d4ab80e6c778744f7e0a6af9ce75d5cd + last_write_checksum: sha1:0781c83abfd647f9394df9de8394682fb4951724 + pristine_git_object: 0b2f2b7effffc8d182401c703d1f8e275f8995f9 Codat/Lending/Models/Components/ProductVariantStatus.cs: id: f53ec5533d5a - last_write_checksum: sha1:08e449b5d65e4b3c5b2ca5dd385070462adac9ce - pristine_git_object: 756c393c1363b960354ffd199d40726bec532197 + last_write_checksum: sha1:ef4ab39f5308e01ecd85acd811b8f99a8df9dae1 + pristine_git_object: 2080cdd4345273d7855562b0151b68596d0c6501 Codat/Lending/Models/Components/ProfitAndLossReport.cs: id: c9a28f6f9926 - last_write_checksum: sha1:57996971fd9edb2bd7a62c70e0f2e42bcb2e960e - pristine_git_object: 6b8e3966e9ab462365e0a4f90c1d0cbc308cbeb3 + last_write_checksum: sha1:1ca243358dceb5afb40424c8c367cc6fbc722ea8 + pristine_git_object: 61eaaa99982b53efa2ab4c4d4107c4620d4a5463 Codat/Lending/Models/Components/ProjectRef.cs: id: ead1de57cfb5 - last_write_checksum: sha1:32045037717df4e00973acb010433b779d4aae68 - pristine_git_object: d05023fc414c7f34a1fabe492866cb5468ae4f00 + last_write_checksum: sha1:8880748024144527af9391a2ecb344269e60f587 + pristine_git_object: c4b672867eca53df0ea5f293e66e7646c26463fa Codat/Lending/Models/Components/PropertieAccountType.cs: id: 83aab1c730ca - last_write_checksum: sha1:3a05e16018ea11bdd9fead35ea2207cc5af336ed - pristine_git_object: 4b7d8dc76f0597db7f3e963ff0d5c694010984ca + last_write_checksum: sha1:733539a226cb133a545a543bb278a68c2a3a1bce + pristine_git_object: bf54e61593db42be80e9bf722e9f2519bd661a75 Codat/Lending/Models/Components/PropertieDataType.cs: id: f0bd050318aa - last_write_checksum: sha1:3abf07579aa888ca7400489874e8eca606dbcf42 - pristine_git_object: c5cbce1a69d1c77409987ddc683080b3ba3a836e + last_write_checksum: sha1:e694786a11c66d7faeffd9f260d778f2b5e658ff + pristine_git_object: c38da6f7277bdb84e5e7bc4470ba3c793f4f5ea4 Codat/Lending/Models/Components/PropertieItemRef.cs: id: b9dbdb4e4796 - last_write_checksum: sha1:9776a909c21c0b0d9e1cf712723a6ab9ec41154b - pristine_git_object: 62e92357806f5e672c37cd6d95df2eb6056841d3 + last_write_checksum: sha1:c2af78db9f7e1f9973e96114f81b65a9c4f2ff3c + pristine_git_object: 1c7d9a30268b287e6484e05187c7ffa1651a4ef7 Codat/Lending/Models/Components/PullOperation.cs: id: f6ff48d340e9 - last_write_checksum: sha1:bc9acdf70c631b800cef3e99d0c34e43c52c5397 - pristine_git_object: cf302c7defd5687223b6c1c3d1e387be4ae19ef8 + last_write_checksum: sha1:463d8f5ed4ccd24674a6460024cd0a14c3b8fb04 + pristine_git_object: 6d44ca878a2517a268d2ade8fb80900495dbb7bd Codat/Lending/Models/Components/PullOperations.cs: id: 9566b117cf25 - last_write_checksum: sha1:2e840de98c7a2451564ad32376a0240dca5f3adb - pristine_git_object: 1ff01b8ea28438aa76ec4803f3c99d1177bf2b87 + last_write_checksum: sha1:228950b06369ea834aae870efec7e5529dde973e + pristine_git_object: a108ed62624f17755bec936169d3108f245a5833 Codat/Lending/Models/Components/PurchaseOrderReference.cs: id: 69d4fcd5f9bf - last_write_checksum: sha1:448cd8193ca1f1c533615fdafd6673017adc1d8e - pristine_git_object: 0c30cc8114bac17ef7cccf4991aa6e8f5cd4bc39 + last_write_checksum: sha1:8ae18aa977d7544e6e9a979d1a769a01f0b08c93 + pristine_git_object: 50c045a60106d0571cefa17b9ec4366d39addd0d Codat/Lending/Models/Components/PushChangeType.cs: id: dd48776ffc7e - last_write_checksum: sha1:7f40cfd8ce9788c46b0fcee081e907dd2b07fc9b - pristine_git_object: dbb3cad3d80c33c8e98eebb7affb9c40af3fce6a + last_write_checksum: sha1:237e42212de0e4f75c7d4f41f65ab71a679b6549 + pristine_git_object: 1decab6e453c564549b83daf71b8a4d6f2608ec5 Codat/Lending/Models/Components/PushFieldValidation.cs: id: 1c52ca6a470d - last_write_checksum: sha1:78919eb945887fdb4ea5c031dd19b4334f6b46f5 - pristine_git_object: e931eb293329c0806181d50818365c62ab22daac + last_write_checksum: sha1:0180c70955f0982be1edf221ab4e72b6a1c34bbe + pristine_git_object: 52beff18ddac65c1150fabf90cdee2489f32cfdd Codat/Lending/Models/Components/PushOperation.cs: id: c9c346fac35d - last_write_checksum: sha1:03e4b4a24e647ba00d916246b77cd666a46a144a - pristine_git_object: 79a45caccb016d586a23c134e0ed6eb2e8b85933 + last_write_checksum: sha1:2ade460d5f382e5769ea3bfa574ef8a43acf52c4 + pristine_git_object: 4412d15742f55b51445e516154e2a27f6c2ae3a2 Codat/Lending/Models/Components/PushOperationChange.cs: id: 6f991c85f4e4 - last_write_checksum: sha1:8e9f0a3615b69a8dd07cb308e6d04c0251d20d74 - pristine_git_object: 1eaf04b02dbe36365ccd6ae6142d4635e6035764 + last_write_checksum: sha1:0482bb70a71f8c4b041d7fe57234de805bf4d836 + pristine_git_object: 19f496b99b7bd21ecddf384852d2b7070fd1f386 Codat/Lending/Models/Components/PushOperationRef.cs: id: e29b24442321 - last_write_checksum: sha1:4360436fb3d7f8245314c95d38933c5ff6d95ba7 - pristine_git_object: 34f03a093de8693a6d9937222210381412fe853e + last_write_checksum: sha1:195a43bd51d4a2703780836a92cd1b3d26f72da3 + pristine_git_object: 2883fe9034a86d34ebfc373842b0ad54582f4f16 Codat/Lending/Models/Components/PushOperationStatus.cs: id: 18b4b7506199 - last_write_checksum: sha1:712fd4ea82ac7341be8709cb82f135209e1d76d0 - pristine_git_object: 3664bbcf30bce45ef1ed9b6dd45bb3d73a2c071e + last_write_checksum: sha1:a34fd75bd0407bcdd471e8f05b43f0aded9f8e4a + pristine_git_object: 0abd70bd384b77aa941affc6e8eaa74cb4dde05f Codat/Lending/Models/Components/PushOperations.cs: id: 8aacce86ec7a - last_write_checksum: sha1:e55f13a364bb99de7cfa0b51fa469719981383e6 - pristine_git_object: 415e75902da3ea267e9a787c486d8acb28b96c26 + last_write_checksum: sha1:ca66964443a040be2077508c7e6a5b0d75de0981 + pristine_git_object: 5e77a12d067b0c93c34f16e4307c581d6600a623 Codat/Lending/Models/Components/PushOption.cs: id: 55d0bbf6795a - last_write_checksum: sha1:e32d5fbe2fb202b48bbdac51a2436909574af527 - pristine_git_object: 7628c14a50e30442bb98c9c621dd7d621d2aeaa3 + last_write_checksum: sha1:233bac6c33d09c371c4e84541d6a45a02805d759 + pristine_git_object: cddf77e73f68ce04d90b865f2fdf5472053bfcef Codat/Lending/Models/Components/PushOptionChoice.cs: id: 72875f0e8611 - last_write_checksum: sha1:98da079007e1f6f3eb74bc672c8c84389dc1a56d - pristine_git_object: 6cfc692636ff6c105ec007ef7f6febfe2a2d3fdc + last_write_checksum: sha1:6446cd55f491e1f543758bac879729310e8b1dbb + pristine_git_object: 3035bca193980b58178b06a6ee345225a80b4316 Codat/Lending/Models/Components/PushOptionProperty.cs: id: 0895c0198c3b - last_write_checksum: sha1:06fab3df6d7d53c97d1f1937c4aeb6028d0ee4c8 - pristine_git_object: 81f2e3d451a1cd34648394847cb14d509d0a24f1 + last_write_checksum: sha1:2156606903c830f8c625570ae7f542c947955139 + pristine_git_object: e079cf989d8dd7b8aae98d46e0547a1ef0685529 Codat/Lending/Models/Components/PushOptionType.cs: id: b3647f37fe9a - last_write_checksum: sha1:c28d36f623ca820597388456030913293b0261e8 - pristine_git_object: 747965c5972b02ba43ab05e574b3009e8cf81ff2 + last_write_checksum: sha1:7087ae2a2da2babbe32b2b149166af602f58ed68 + pristine_git_object: d8a17c79ecd639fba059ea3715a98ac6005b783a Codat/Lending/Models/Components/PushValidationInfo.cs: id: 9042472f039d - last_write_checksum: sha1:33c3d1947d89cfa7c03f10b29d233b8eb6130461 - pristine_git_object: 9f287011f7ffb95597605de9c5d46542bea6de5c + last_write_checksum: sha1:3d61e972b4baa7e65bdfe4391f0056fdb003ad11 + pristine_git_object: 1dd657bb7f806cb03d30bfb7edebab4469d1c2d5 Codat/Lending/Models/Components/RecordLineReference.cs: id: a8ea131387c4 - last_write_checksum: sha1:7a7cd6b3961dcc451010f3dce867259c92696d33 - pristine_git_object: b982c39c6985217d2114bf64fbbe99645ef3b397 + last_write_checksum: sha1:bb4025cd862843ad7eb909b8e7a7419decedc572 + pristine_git_object: 739268ceabd5591582ef495a4d14071ad1abf327 Codat/Lending/Models/Components/ReportBasis.cs: id: 9a7f11fb0ee3 - last_write_checksum: sha1:8fd4684c6ef8c7a430ca29b8963947ce6b73bf90 - pristine_git_object: 25c93a8f234d8cc21a7d21a359827cde8d27efcb + last_write_checksum: sha1:86b426330e3d5ed88792fb757b98b98a4d8356a7 + pristine_git_object: bccba04196fc01a31ee6ee1ab0d858bbfbdb55c2 Codat/Lending/Models/Components/ReportComponentMeasure.cs: id: f0d98ae47d37 - last_write_checksum: sha1:848fb8184782c9c3725296bb362cc69789d07147 - pristine_git_object: 6b13d82544b5316c20acc21ed985e48463f98a18 + last_write_checksum: sha1:cdf2bab1b2040e8669948b77f34521d106790c71 + pristine_git_object: 0584ac4754d335a94a6479016d9b04f62d254962 Codat/Lending/Models/Components/ReportGenerationPayload.cs: id: 698d48d5affb - last_write_checksum: sha1:a5b0513eb79b4c82669e1d41c4f81e697b1c741f - pristine_git_object: b850632056450a8f51054bdee369c76c4f558e9a + last_write_checksum: sha1:115c514963fc9e77c0518a337b7f3b001bf6bd9a + pristine_git_object: 3816cc2255add165f03d45977bf2ba453d4394ed Codat/Lending/Models/Components/ReportInfo.cs: id: 0886edbd447f - last_write_checksum: sha1:4461b08e2481fbd7694e2ea1b2e6d157b97f9b7b - pristine_git_object: d6835d56bea29708ced4dae87e2e7808bcfe4463 + last_write_checksum: sha1:a4c5a224af7beec9ff3f05cd11c5a42a17eb98fe + pristine_git_object: 46f67df9bf4e1ebb994f57a68aeaa92d3de90a28 Codat/Lending/Models/Components/ReportInput.cs: id: ee93272bb2e0 - last_write_checksum: sha1:e6d34b546108af370207d62db1770b55ee811650 - pristine_git_object: 5cc8910368ea61679aee1709a53e3e8452ffbab8 + last_write_checksum: sha1:1fb26150058caaa618d12450c8f9d3b59c16b373 + pristine_git_object: 8a6ee46d2cc15ec1a9f6a3f0697ab8f05aa89ebf Codat/Lending/Models/Components/ReportItem.cs: id: ea2b14a56c7b - last_write_checksum: sha1:cf9f425f44b1bb0ee1732939d4af36eda295daa5 - pristine_git_object: 8831357dfb72818c55c3d723ca2df6c51ed0c2a2 + last_write_checksum: sha1:74a7e49cf0ef860ef295a4e25316d7e63b630c60 + pristine_git_object: 0897bc0c97f439fdec9a3be13101d1f1be0791a3 Codat/Lending/Models/Components/ReportItems.cs: id: 2a0c0542caf5 - last_write_checksum: sha1:4b50b71c6ac1bdaaa0113ef8dc635670f2b4964f - pristine_git_object: 2bb0ee3f07380db6386876a98d7cf18253b22022 + last_write_checksum: sha1:1a3157bdaf78c2a502bada218aca5823043f247c + pristine_git_object: 01bb8a1a54c7ea052ca72c386f509b1ed1012cc3 Codat/Lending/Models/Components/ReportLine.cs: id: cfa344b5c32c - last_write_checksum: sha1:510426dfd5c38123ee7168f079a95a87a1f98d16 - pristine_git_object: 9dc2664485ca3923ec5bf5616ff4ef28c5ece810 + last_write_checksum: sha1:cfb699845bf43faf02a57cc2ed7b028355e3b071 + pristine_git_object: 0e88b5ff6a673fd737b5d94a42e729a154e3fedb Codat/Lending/Models/Components/ReportOperation.cs: id: 315e2e93a634 - last_write_checksum: sha1:d56b879d8e26d0603ed2c56567a785f8778fe429 - pristine_git_object: 6a139238d8a4bd08e60c376a5050b5f381b250b5 + last_write_checksum: sha1:4f0ba9d9e83dd6075d5d1d27952e49868675cc3c + pristine_git_object: 7a3df5064b04a9e9788e0621dbed49af3f034ef8 Codat/Lending/Models/Components/ReportOperationStatus.cs: id: 0060ee11d066 - last_write_checksum: sha1:90fc81c2a325f466c308c633d784eb8b8a65b30a - pristine_git_object: d9b2d9d5f0ea10c31970619539e58e0183d607fd + last_write_checksum: sha1:761ccb4b4bb3c60f9df356f8c52c98cd7c5afaeb + pristine_git_object: 184cb7a3c000192065c4c7ba2d73e5755a973a86 Codat/Lending/Models/Components/ReportOperationType.cs: id: 81cef876f8bf - last_write_checksum: sha1:8ab48bde8b73b39b9f2505188851ea4ed2b221bd - pristine_git_object: 3b599a536e8206f749230a81ebfcdf4aea5563e7 + last_write_checksum: sha1:19dc18523cab68d11d0140c16f7e89bfba10fea2 + pristine_git_object: 6833d1efb51b728850dcb4fcf917a47c33f9024c Codat/Lending/Models/Components/ReportSourceReference.cs: id: 7e12f05ffe78 - last_write_checksum: sha1:ae41a8f3f7735a12c2654673c39e13a39b3e25b5 - pristine_git_object: 21b6c4aeaa016b4a5e4c0baf68a4c9aa338d31a1 + last_write_checksum: sha1:eeacfd463e44da3a8905db310139d518d1cac4a6 + pristine_git_object: d18fbeb55a182751927d8b1eafedd5d1e8af39f2 Codat/Lending/Models/Components/ReportType.cs: id: 137fcf60dcc0 - last_write_checksum: sha1:06ded83a5b0590841d315b42352ce8a8abfdafe8 - pristine_git_object: 679a5bc82ad2cc959a45ce25fc49c8e5b2cb079f + last_write_checksum: sha1:cc8c5aeef646ad4fa280f89228d4824834f35bea + pristine_git_object: ed5934bc994ab64c1864439420c2747db27ec5ce Codat/Lending/Models/Components/Reports.cs: id: d939bbe0512c - last_write_checksum: sha1:9143c859d0a2583c819e7e46721a8f3cf9607a0e - pristine_git_object: a5f54e2334c0f0788bc3bd66baf1df9ed654625a + last_write_checksum: sha1:2c15a267b0016357ca2880b2eb331fcf01d39382 + pristine_git_object: 326dccc2880e20451dcf46e7a718a0cf435240a6 Codat/Lending/Models/Components/RoutingInfo.cs: id: 56b64bf6cb76 - last_write_checksum: sha1:de6373c48074f55a4f311fa3a21ada80d678dbf8 - pristine_git_object: 05ef0326c231e8f0ca656239cd84186f2ca3dab5 + last_write_checksum: sha1:8ae93d28c756e799cdb795dcd67a7d5dff658d8a + pristine_git_object: de1c6d9567c558183c749cf0937b84bed1dbafc0 Codat/Lending/Models/Components/RoutingInfoType.cs: id: ed92c5a569ff - last_write_checksum: sha1:0e4d67d8c9e59dd6aca3ef7d998bbdc2d6773bc6 - pristine_git_object: 4b48860dd8f4c68983685cac352392f98fcbc6e1 + last_write_checksum: sha1:e8ef035a84c8e7f33b8c28f417d3519491bc0a00 + pristine_git_object: b57bb5cb8ed435e53508a04148442649a558c1a3 Codat/Lending/Models/Components/SalesOrderReference.cs: id: 8e963ac17b42 - last_write_checksum: sha1:3b1e3ea2ae2f1d3746b3875899643ad39a2664f9 - pristine_git_object: de0cb1bca674f7f0910fd0bfccb5167f6c5ec028 + last_write_checksum: sha1:c943ebef83d50d39167edc704eac7f3f7dfac852 + pristine_git_object: be4ba8760cf6ad794f076da0fd94e4107d86272d Codat/Lending/Models/Components/Schema.cs: id: c0c93a87226e - last_write_checksum: sha1:70ce0ded0622d2115acee7b8beb70145004d2c85 - pristine_git_object: 9d1a35be786d779d4bd58967f6f541de8e2ded41 + last_write_checksum: sha1:53638c2ef4be318a15ea1b75dada5af6f28e393a + pristine_git_object: 20994bf92bb136d5b70c830a1713bf3aea7f624b Codat/Lending/Models/Components/Security.cs: id: bf44fcbc1f2b - last_write_checksum: sha1:2774e160b35f83ab2567a8dae57ae286b373f1dd - pristine_git_object: 8a3d4c199e1df058ea5e43e61f8c2104ecf5e4e9 + last_write_checksum: sha1:474837ad6b9124083aa1ee868903671e299ceb7a + pristine_git_object: 837e248a960d89500d323c2c28746448e6ba803b Codat/Lending/Models/Components/ServiceCharge.cs: id: cf04d2186bd9 - last_write_checksum: sha1:85d6941d5b72274a0670dea7de7dff2205b21d42 - pristine_git_object: 58b1c90ab1430a23a5177e4d985d436d5045ffc6 + last_write_checksum: sha1:b26f352ac97ed9eb5cc24d41ebae6cc2d2cdc3a8 + pristine_git_object: 807ca2ffe43126bc513af73ae2ff85e2fc687d73 Codat/Lending/Models/Components/ServiceChargeType.cs: id: 641dd8ce61a8 - last_write_checksum: sha1:542e0e5d1251b9e3cd60f6472e0a23237fb29381 - pristine_git_object: 6286a7a1338057e0485b9b17f58e7bf7a33edc05 + last_write_checksum: sha1:8c802520ea54bc00a6fb1c06c234716cea2b9576 + pristine_git_object: c8772a7f9bf2b54ffb168fb04bb59e8384541282 Codat/Lending/Models/Components/Source.cs: id: 646c800352e9 - last_write_checksum: sha1:2bbdb35e956af830a125136c0cee43493d4103cd - pristine_git_object: cc7b1abdc6ab32f78eec1a75369d4e30c5c13943 + last_write_checksum: sha1:8e7c8f65178d3daffdbc15561b1e3f9291ef5c43 + pristine_git_object: 247058628785ce0d6e76db59c06b511991cb66c2 Codat/Lending/Models/Components/SourceAccount.cs: id: faee7e09572b - last_write_checksum: sha1:6a4558e3c1b18c917d9a3d7f01d131992297ac4b - pristine_git_object: 87fbd65070b76aea55f6fa1a5988edff6d0c0645 + last_write_checksum: sha1:617909c18398118587239d4801a67e90cc1b0e89 + pristine_git_object: 89e1cac5794f42c8ae363a7deb87da9fa47767f5 Codat/Lending/Models/Components/SourceAccountPrototype.cs: id: 8ce2308bcc76 - last_write_checksum: sha1:be98f50807efccf8b1547db019cda51602034430 - pristine_git_object: 8dea096108f2ab6b2208bbf4ce2caba9b6167870 + last_write_checksum: sha1:984f89e101de8ecb8dbb27d01b29f691448148eb + pristine_git_object: fd443e5cb8274e2c1779026af6368c9f3a07dbbf Codat/Lending/Models/Components/SourceAccountStatus.cs: id: ccbd9c61941c - last_write_checksum: sha1:5e250623ca9cd617028a3c2b669c155fd24af5f7 - pristine_git_object: 0fc7c74d8eaec9222b47fdfec336e5b07a6f905d + last_write_checksum: sha1:055898a682a716678c9771050db9b5f1de2f2958 + pristine_git_object: 9792e42d2da2ffe8bd9c154f1b46b88b2f593679 Codat/Lending/Models/Components/SourceAccountV2.cs: id: f636df1e70ab - last_write_checksum: sha1:aeb7a51f365bcb731e88ba360a190c7c5ebcf003 - pristine_git_object: 9bea0c456599ae30c454bbe6ca77920a8c2ac237 + last_write_checksum: sha1:c06bff5f40e5a6c84f8f7566214dbc2530e42c77 + pristine_git_object: 5045d10e6d829e62315f3b754cfaa004d05ff2f2 Codat/Lending/Models/Components/SourceAccountV2AccountType.cs: id: 12f735f7401d - last_write_checksum: sha1:95d368799370371a80a8db3c1967e040ac04ea61 - pristine_git_object: 552d0e43a577b380e6af6a29582f8eca3391b9c1 + last_write_checksum: sha1:15bebc47dca43c2cc3bb88e7f8f4683ee4823a8b + pristine_git_object: 877a5da3ad59a268a718e74aae134f88c648cabe Codat/Lending/Models/Components/SourceAccountV2Prototype.cs: id: 0444c3ec31fb - last_write_checksum: sha1:dcf0be53ba5a95c10c6148925aa96f50dc1aaa1f - pristine_git_object: 64aa46b006d5bd50807eec11a513cb3450cd9b7f + last_write_checksum: sha1:9714a45426525ba861dddb2477594e328c199ccb + pristine_git_object: 00dec3d9347f58920f23e17aadb69a8875aaaf56 Codat/Lending/Models/Components/SourceAccountV2Status.cs: id: 56b3d423d55c - last_write_checksum: sha1:1283a9c1ecf2d005433ab5ae20cc119d36f41f53 - pristine_git_object: c6844e5bdb7918cd56810e834b03c63967c64fd1 + last_write_checksum: sha1:4aa32dea955fa75afc6f26e6c399e8c9034e52fc + pristine_git_object: 44288d4863959f771ecff6793188141514f87d83 Codat/Lending/Models/Components/SourceRef.cs: id: ec9a1decf3f0 - last_write_checksum: sha1:b703045ab8868b57e62129ba672ff6486fb7586d - pristine_git_object: df03b6d699ecd235075f35fe314cf5ef867ae57b + last_write_checksum: sha1:694eb553640f671a4c333a9dff4efd5a4f4764db + pristine_git_object: ef196ceb560175fb4ce4a2838d84f20ec981221e Codat/Lending/Models/Components/SourceType.cs: id: d25a5703a3aa - last_write_checksum: sha1:706ddb6d5116338f61db4cc9c5735c711258f1a5 - pristine_git_object: fc66a9fb0bf9e3ddccec311978d84d71ca73a96e + last_write_checksum: sha1:0bc72d8378d0bf6e577d80f3b4020cb358203192 + pristine_git_object: 0f7af5f8818907a212cf6a43c187ecff474f449d Codat/Lending/Models/Components/StartUploadSessionRequest.cs: id: 7fa68a38234c - last_write_checksum: sha1:7bc0411675aad671b01e66391f8d1a5ec821edeb - pristine_git_object: 4d7df92c7f99b75f3ed5af23f9e60027b72b65ed + last_write_checksum: sha1:4a180a2bc31a1f16ab10bf8ad6d76aaa5ab7b667 + pristine_git_object: 099ade576f70ff530ead8c8d6a7b71f3000567c8 Codat/Lending/Models/Components/StartUploadSessionRequestDataType.cs: id: 2a24a416c824 - last_write_checksum: sha1:a9cccf617aa1b1f7e81fff2dc6f7c2e58fa72dbd - pristine_git_object: 8f76d0b79ba870f135683edd4c72329ce29c7207 + last_write_checksum: sha1:133e5b6c68abe3890a3b2ebdc5934d426932c55e + pristine_git_object: c1aca5486a57f15e95f4eb5616e3e734deb8cf12 Codat/Lending/Models/Components/Status.cs: id: 282f1068603d - last_write_checksum: sha1:1793a6d739f39ebc7630a5922ab7d47fe1120604 - pristine_git_object: 9f7546be8a7fd2412b0bd1eb5a016a5c7cbbb30f + last_write_checksum: sha1:5d6f859a3d1aec1b19f566de589ca07a11552a5a + pristine_git_object: 3505ea39d9d70927e45ebd40d22022d6ab8c0301 Codat/Lending/Models/Components/SupplementalData.cs: id: 3682405cdc57 - last_write_checksum: sha1:1af50103614bb69d50958179071c209c04731cb0 - pristine_git_object: a2e705899b7d7fa5c8f6561f63d801bf6d23e914 + last_write_checksum: sha1:f3b9a696ad005f294096d3b2ab451630230a5dcd + pristine_git_object: 20b5e85264622a05858081ec805921865a050d5a Codat/Lending/Models/Components/SupplierRef.cs: id: 7fc0c538d83f - last_write_checksum: sha1:4f6dffef8765b615e563a14239770df794e4232b - pristine_git_object: 28d42e8473b8a35afd114e5ef0470d8f8d307f80 + last_write_checksum: sha1:24a0ee217618a2e2eb75f96e53d5442a7185a185 + pristine_git_object: b811b4c4983463b6b70e8f722e74ce707d40f6a1 Codat/Lending/Models/Components/SupplierStatus.cs: id: e08b26e36c29 - last_write_checksum: sha1:2b87d56a03cae285ef3f0cb85c20a9e14d40223e - pristine_git_object: bce625e8c2c2c8a4d81c208a545c0db568d41a11 + last_write_checksum: sha1:ca9a06a1f852066bd6814117ea64ddfbc9b7d3b9 + pristine_git_object: 1ef91f654856abdbff2b5abc813c39c801858626 Codat/Lending/Models/Components/TargetAccountOption.cs: id: b95033b56117 - last_write_checksum: sha1:ded6e6721c33b3c13e4ff0877ead74c99c996a98 - pristine_git_object: 9d19bbf59adf07d61cbd289896a1cef86536136a + last_write_checksum: sha1:c570f886662b4880c4f6439fb6e152ecc44be227 + pristine_git_object: f1e9823d4635b7451d40ebb0bb53f337ede164dc Codat/Lending/Models/Components/TaxComponentAllocation.cs: id: f7002d5400ab - last_write_checksum: sha1:a4960b6a157762c284c0b601485205a9309bd44e - pristine_git_object: bf0903ed91ec671b7d1e074f954637c7fc41598c + last_write_checksum: sha1:6d5cb778ec24f42c80b9c01bc072f9c0bfea9b81 + pristine_git_object: b4f83cd7b3ade4e432eb72d63ad9dede45ff930f Codat/Lending/Models/Components/TaxComponentRef.cs: id: 42f57a41b73f - last_write_checksum: sha1:b8d2ae106e57062257dd015aea99b4d61d818a21 - pristine_git_object: f77efde7dd4a65b996b05b2c63644e44442a73a9 + last_write_checksum: sha1:c41a6ae3e42b7e5faf6d28c7e11470a2ac31c6d0 + pristine_git_object: 4d8b10fca4334c72aad4a93f4aaa74bad3130297 Codat/Lending/Models/Components/TaxRateRef.cs: id: 1c08f19921b3 - last_write_checksum: sha1:d08e8070bf877c8dc234b14b07de92253287434f - pristine_git_object: ea2a58b73bfb0fe71b79e386aea32ac7651ff5ee + last_write_checksum: sha1:5dda45bfc1e4e9e81ccd32eccaba6e01f1938cfe + pristine_git_object: 33a2b53cb87b35901ffbbae3487e7b87db9bd2c3 Codat/Lending/Models/Components/TaxRateReference.cs: id: 89d849d41669 - last_write_checksum: sha1:93c81e046eeec35b8b48c825f828da371dffa2c0 - pristine_git_object: 64d648f5c775ab0d20ec5b9a31041e02227c5601 + last_write_checksum: sha1:934f8ba27a6cf45c61034839522b98b10e6c3e01 + pristine_git_object: e59116789dc330e7ba86034f98a77de203db8cd9 Codat/Lending/Models/Components/Tracking.cs: id: 9958120aa92c - last_write_checksum: sha1:5a4e68179e23a7a5111ed543ce93a347abf1f2e0 - pristine_git_object: b1ea8675e6c674bba459e2b25817a1dbd4f6cf81 + last_write_checksum: sha1:45c69f8ef0021055c3151792d198675ad61000b1 + pristine_git_object: 45d21a8edba7c932d6c9ea36d7ea85d1db7a97b5 Codat/Lending/Models/Components/TrackingCategoryRef.cs: id: 5a255fbeafc3 - last_write_checksum: sha1:c7c1b58b07298130825ea1d3a1a452f5269d92e4 - pristine_git_object: f1f822e7fd1b452acccadd95fa1df762bc926dfd + last_write_checksum: sha1:c526c4ed5f24716f851a9679400d9c2d0681a021 + pristine_git_object: f1bd4394000132350411e6229df40383846ce7b0 Codat/Lending/Models/Components/TrackingRecordRef.cs: id: f524767df4e1 - last_write_checksum: sha1:a16e3218656456bf3eb28d71087d482403db8e5e - pristine_git_object: a355e0090937dda6597bbe4809701f0d74c604af + last_write_checksum: sha1:1ebf587609e5812eca3a6c22958c48b0baac90a8 + pristine_git_object: 55390d9a184911fc40542fe6e4eac3e94e99871f Codat/Lending/Models/Components/TrackingRecordRefDataType.cs: id: 725987df1b3a - last_write_checksum: sha1:d95f6d0e67711e99c84c675b4a2b64fe0f380f80 - pristine_git_object: c96886abc0c40488125f696c00f955d35ec6d3ca + last_write_checksum: sha1:744ff7b0bdd71561b048876bf86363bed4589f96 + pristine_git_object: 5305a8671a59e3d12ae4044cac66d63969bd6521 Codat/Lending/Models/Components/TransactionCategory.cs: id: 4e9100043cce - last_write_checksum: sha1:67a978ded6118254330c8020a1f8999ef7ccaa7a - pristine_git_object: 3111e50d677a855a2ce41312a45ed0ba90f0d4fa + last_write_checksum: sha1:eaafb43ba32b67c9901a8fc66e92354e4aa11ac1 + pristine_git_object: 41b9dc8c98f713d3ff3f415d4818cb866f0bc895 Codat/Lending/Models/Components/TransactionCategoryRef.cs: id: 81658c302444 - last_write_checksum: sha1:ebb3c9250f854eeef2e268b0af4a2d358a5c2a5a - pristine_git_object: 21518e6f2bf02f421c8b2592fc45f302f8d8e866 + last_write_checksum: sha1:3c3eb97e542fec32ca1572b3b92ce8e439ce119c + pristine_git_object: e2b63883efc309e6971a0986d6b13e02837881d9 Codat/Lending/Models/Components/TransactionCategoryStatus.cs: id: fc7f81db4240 - last_write_checksum: sha1:959dfce8597ffeccb69a7a6879b5b54f5e0e0895 - pristine_git_object: e73fce7d66e94e538eb0191f36d0558880a042c0 + last_write_checksum: sha1:a7b43af1292b4cdd80fe2dc6fde778c92a81ac32 + pristine_git_object: 1b58e4ee9e947d95ebec48fccad702ce9f4bedf8 Codat/Lending/Models/Components/TransactionCode.cs: id: 3bb4e4b88725 - last_write_checksum: sha1:88528f6c1ff5dfe52162275810a08be75786045c - pristine_git_object: 5b030c7897d0f070654679cadf4cdf5a594b51a2 + last_write_checksum: sha1:b066681f33cede92fc4603bd3478fac5034f2e93 + pristine_git_object: 2456f0fbdf7d4f00603160f4d1297fc9d851f2f0 Codat/Lending/Models/Components/TransactionSourceRef.cs: id: cb818fd60fa4 - last_write_checksum: sha1:902357f059a80c88b6540f576d5adfa0e0e01fbb - pristine_git_object: b46b2ff9da1514d2b417f94bbda77831e18c5dcf + last_write_checksum: sha1:4244164f8b03add6e1d60f5d692d53c5039bd494 + pristine_git_object: 4751b3c49cbdaf03ecc98e88a73a017fa9ad6602 Codat/Lending/Models/Components/TransactionSourceType.cs: id: e466f0170c0a - last_write_checksum: sha1:66d064e9805750af0d8a2f5e1e58d675ce53cb9e - pristine_git_object: 2118eb3709b0b729daf4f07877e84a5646d778e7 + last_write_checksum: sha1:1caf4756056ee6209f9a8b6f14c96f91c080fcbe + pristine_git_object: 1f87862316e0057cb1e1b4566b0b422da42ace5e Codat/Lending/Models/Components/TransactionType.cs: id: 2790f19b61ac - last_write_checksum: sha1:411d24445e0f6eb92121fa1e362c92515511e663 - pristine_git_object: 1a23193573174bd4b0489dc528aa1a25bb97af39 + last_write_checksum: sha1:25f6c9899356aad20ca74f79999be454d87c1b11 + pristine_git_object: eb0a686969f26a8a6a83748db897b997e529249f Codat/Lending/Models/Components/TransferAccount.cs: id: 98af9185f2ae - last_write_checksum: sha1:692ed64039a0be914d65bdad1d6e1b64326c2849 - pristine_git_object: 21e375be393cf5bdfb702381a630dd4a8f4b09ad + last_write_checksum: sha1:b73141feb4826f67e8383f1ba91b3fce1e326249 + pristine_git_object: f671f465b5ae13410fd317523246e1ba4f739e62 Codat/Lending/Models/Components/Type.cs: id: 7a40276a2aca - last_write_checksum: sha1:421c00375581da58588cda12570ce48473b3d845 - pristine_git_object: 1bbbe5d9e171357411f8e3fcabfcc212e58af347 + last_write_checksum: sha1:89d3482a34e2a74f05d845e193225d79854f0e33 + pristine_git_object: 3dd79e57102d63bc41edb7815bdb71e21d30264f Codat/Lending/Models/Components/ValidDataTypeLinks.cs: id: dbc5500025e6 - last_write_checksum: sha1:82f26a3aa06ef49b4158f318b30e39811c537a0a - pristine_git_object: fec3a60a4fbf971c8da070ec9c5490e6401f94c3 + last_write_checksum: sha1:28d4fc08b25df5694c161bd97d1c56347503b544 + pristine_git_object: 217c3310f4111b46b68a2cae8a1f07a0c6cee5a2 Codat/Lending/Models/Components/Validation.cs: id: "797973000445" - last_write_checksum: sha1:74f13993b89be6f56f91fd39ecabd12299fc7ef3 - pristine_git_object: e37b7cccb036b1ac942cbbf877d990a2d1c09cf5 + last_write_checksum: sha1:093dc24dbeb1b3d64d353e47eccc7948ad29bcfe + pristine_git_object: 539e4defb7468ca555f0b39d57e66d99d7f09e87 Codat/Lending/Models/Components/ValidationItem.cs: id: d0cdcf48560b - last_write_checksum: sha1:33a3672d9de4f49dac383db82bb3af3183e715ac - pristine_git_object: eaa7ac5917a06f818c62df782471ca2dea939d6c + last_write_checksum: sha1:956c99245db87b1c3ada146f31c48bc10664414d + pristine_git_object: d7f9dbb392401a6f11b647d446cf87a44ed1b13e Codat/Lending/Models/Components/WebLink.cs: id: 905ee559fc02 - last_write_checksum: sha1:063fcf79e8d1a7f980712417c78d00deccd8a11a - pristine_git_object: 0acf240513c16985a697f5596c509acbb7ba41f2 + last_write_checksum: sha1:29e9ff80a2b7c5564706a08fdc41f3f08ffb8cbc + pristine_git_object: 36217b7f211a8f3406a39d6c313e6fc4efc344fb Codat/Lending/Models/Components/WebLinkType.cs: id: 9006a87f3172 - last_write_checksum: sha1:c6e69a12861897e0effdcf8fbcf74506a75e592b - pristine_git_object: 53a3ca502d0c0c819fb82a0b084264daf79eab3f + last_write_checksum: sha1:5b6512f9f4375ed9fd80e7e56325bb25e362d36d + pristine_git_object: 338ea4aef62c3f2acb6738991713a0d00947eed5 Codat/Lending/Models/Components/WithholdingTax.cs: id: 3137f960a456 - last_write_checksum: sha1:1bbc534276faf6680bb26c7f7d7eeaba2a0af43f - pristine_git_object: a08c4ba9b0fa6669669be0a3a9dabc68b012b604 + last_write_checksum: sha1:7416cd207f29717e5f7350c933740d774c0e3e6c + pristine_git_object: f575a1cc11160640107eb1d2907e285db2e7656c Codat/Lending/Models/Components/Zero.cs: id: f48ac103080e - last_write_checksum: sha1:3b0cd625b5829b66a0266c7d6c7725a3fce8d896 - pristine_git_object: 7a867fc0f963823acb48c75f6f8c59b2c95d6042 + last_write_checksum: sha1:c1dc416ed053f32594820a533b0d96e4c0df84eb + pristine_git_object: 913453a24dd9608f1c092b654a8997915f170687 Codat/Lending/Models/Components/ZeroDataType.cs: id: 8bcf780fb157 - last_write_checksum: sha1:ddcb274e2825693a82019010b36528beaa7fd8cf - pristine_git_object: a940d3cacc6f40eed5af7bd68fde13cc4e45e484 + last_write_checksum: sha1:306d0a77e3c8220f96fcee85a990cf4d644089e0 + pristine_git_object: db19da058cbc176d5617419b6a74786cd235be39 Codat/Lending/Models/Errors/CodatLendingException.cs: id: 733a7bbded28 - last_write_checksum: sha1:95303627a83132fe80a6c3c2944c801633d6ea98 - pristine_git_object: 7f5c9db1172513309299a9704780d5b3e8b0d7a8 + last_write_checksum: sha1:7e9ca0d30686c7e15fdaa36ae3df98bc0b22254c + pristine_git_object: d5b3675a95dc70a933f50600b8d7bdf284b5f224 Codat/Lending/Models/Errors/ErrorMessage.cs: id: 740b4d47ba71 - last_write_checksum: sha1:05eadf134c9300865b9f73f4e01a3b455fde9b22 - pristine_git_object: ea021a4931ac5ce517a8e96c9149f66523226a3f + last_write_checksum: sha1:f9c2ae74bc33cd5d54427100bcc6060ef934cd4f + pristine_git_object: e4a7a4cbd9036472297e818c090833d38c8983f2 Codat/Lending/Models/Errors/ResponseValidationException.cs: id: 1cd8db1918ae last_write_checksum: sha1:31321ff670761142bc9be942fd79c3de9f7a9c70 pristine_git_object: 804a9c8b099cab604172833cc6e7940d96af9311 Codat/Lending/Models/Errors/SDKException.cs: id: 315803e321b2 - last_write_checksum: sha1:ccb2100df07d21ad6796b82680672b277dbf1692 - pristine_git_object: 0525216567f14e9d551a0642feacdb2d2ce02509 + last_write_checksum: sha1:232a028de2534e93be26995f5da41ecadafc4740 + pristine_git_object: d61a901140cfb9fdc75def9abea228be2dd77061 Codat/Lending/Models/Requests/CreateAccountRequest.cs: id: cefadec48de8 - last_write_checksum: sha1:19af64aabce6d05b7818cf8a88b089ea97e167bd - pristine_git_object: 2ea97d0c4ac5784f69c87208974d9857ec37754e + last_write_checksum: sha1:f8ad4e2480ebf28153853317c120bab0123e3a42 + pristine_git_object: 8a4c32356bcd6aa1fb546e814df0d4fe1a6f7ade Codat/Lending/Models/Requests/CreateAccountResponse.cs: id: 342dd577c2d6 - last_write_checksum: sha1:41324cc884aa7098aea39149db9dc82aacf700f2 - pristine_git_object: 961a998a389bf332f9429becf2af4b44961ac095 + last_write_checksum: sha1:10f766827d7a37a0623add63745166b50118e8a3 + pristine_git_object: b8cc64f2b7b727a05c5b56d77c8abd929c26866d Codat/Lending/Models/Requests/CreateBankAccountMappingRequest.cs: id: 87cf6dcfc475 - last_write_checksum: sha1:4379d72123875945a4a917833b80dbaf5a447f3d - pristine_git_object: afcff73fb4411308e6d2a7cf6f2f6a87b86d4d96 + last_write_checksum: sha1:4aa1c42b594d7deb98d19d1002b18cf570969918 + pristine_git_object: 894d19535b9232f1ab156e39dde790ca34d830b8 Codat/Lending/Models/Requests/CreateBankAccountMappingResponse.cs: id: f3549bf0a3c9 - last_write_checksum: sha1:fa8a77c11f418430bbdcac5d6d25320d5cb7cd52 - pristine_git_object: ca9a83e848b2c9e4f7a63ae36628966411f19559 + last_write_checksum: sha1:e46e67271059acae5ca4f5242dcf81c6308cd9a3 + pristine_git_object: c10cae54f13f02c2af684f7b42a5db29f5b5fafe Codat/Lending/Models/Requests/CreateBankAccountRequest.cs: id: ba947592433f - last_write_checksum: sha1:9f8e0fce5f4cdb168ce371b2ad8a1556b6ebdd0d - pristine_git_object: c9ad295169beecb20e96fea71010b3fd1d421cd6 + last_write_checksum: sha1:5a26be63123b69bd9da195b0867d69d7d02bc899 + pristine_git_object: fed892cf92309de5163b21404a640d13a22ea977 Codat/Lending/Models/Requests/CreateBankAccountResponse.cs: id: 0517248d454f - last_write_checksum: sha1:08a4fdb5d0c4fe314f42b3aba05982338c4cab72 - pristine_git_object: c642d5cb08b9c27ac56af72f75be06519a38dccf + last_write_checksum: sha1:31fbd4d5b6712581752f7376a99b909cae30f616 + pristine_git_object: 9f1934c3dd981210ab9e91da7ed6eb8ac5e23da8 Codat/Lending/Models/Requests/CreateBankTransactionsRequest.cs: id: 4d18da9a7212 - last_write_checksum: sha1:9bb7598ff303cf06f904dbfde20a69e9950a16ef - pristine_git_object: e11e4368c33e6777a3b32ab06b03525432f0bd6d + last_write_checksum: sha1:85a48424cb027005d26362b19ee2117e17a0e93b + pristine_git_object: a789f572ce583339d6ae2ff7306ea84dfdebe147 Codat/Lending/Models/Requests/CreateBankTransactionsResponse.cs: id: 59c574e61cc5 - last_write_checksum: sha1:8b4eb7919125f7ee1d2265effde61e1561c8387a - pristine_git_object: 9107b0f704727734752f8e48e6d75d5806706309 + last_write_checksum: sha1:ddfa305483e09dbf4d7f52314c9a9530c2a09ca1 + pristine_git_object: 2eaa739c3ebfd955b41f9562db4ca961383f2934 Codat/Lending/Models/Requests/CreateCompanyResponse.cs: id: dc395611df9f - last_write_checksum: sha1:c30fe0cdb8b64b355c8d06a8d774cfb843e83a81 - pristine_git_object: 968df138af63157037fa3f8ed3f8b350cbb9189b + last_write_checksum: sha1:7b14d0c3113b2be935af41d6c0bf33bf72674493 + pristine_git_object: db654687ceea6fd0d005b5de479c8699df7c9645 Codat/Lending/Models/Requests/CreateConnectionRequest.cs: id: 5ba169a15793 - last_write_checksum: sha1:8ab6667c1e85ea0b48734b0701a7abed90b4b879 - pristine_git_object: fbd0175de1584f83bb5e1290bbe4438ee98c5927 + last_write_checksum: sha1:c5352ffdd63c7cfa50c13a6fa87be8a509aba22e + pristine_git_object: 2f7a4a3f16565fc5001862edf3dde1b498924bcc Codat/Lending/Models/Requests/CreateConnectionRequestBody.cs: id: 5139e4b0fe95 - last_write_checksum: sha1:51b7e756d20ae8888574bb205781f524978506c4 - pristine_git_object: cdfd7602c04a4053fe23a4c7a364557a661ead5c + last_write_checksum: sha1:a12765014e5e328897f0acee037c048ee91c531b + pristine_git_object: cdf99407e2cf68a0d88cbce42865eb6c349ba3fb Codat/Lending/Models/Requests/CreateConnectionResponse.cs: id: 685fe5a4769f - last_write_checksum: sha1:23f661a4d18bcdf255b6297cd0bc18eabafa53a7 - pristine_git_object: d9f6d14a3a5953b598a9b7e2c93cac472fbb0cd1 + last_write_checksum: sha1:88ef70d0287517cdb49be726e3b1d3f408d68d1c + pristine_git_object: 389f5818d9439a39710983e4d3f9605448ea235b Codat/Lending/Models/Requests/CreateDirectCostRequest.cs: id: 73b642b7082d - last_write_checksum: sha1:186ff27a66635f5db258d541974e930407edb203 - pristine_git_object: f8204418b845c3820109d34c90f3cdba41832026 + last_write_checksum: sha1:03108a6fd4bc7de5bbaa52269b7646d52b53bba9 + pristine_git_object: 7f60f3f6675012d2bc7ffe6482d42b632dbf6730 Codat/Lending/Models/Requests/CreateDirectCostResponse.cs: id: 774fb5e56521 - last_write_checksum: sha1:6f302c0c2434359196aa8a2f3de9b92df622d0dc - pristine_git_object: 18651950db368c7a4be3ffdd5521eb9204f6ba47 + last_write_checksum: sha1:4ec11bf65a4c35b016c11548095c8863b713038d + pristine_git_object: 0590a7e9a3eaa8c1b1f0953d71d89761b68d8fa2 Codat/Lending/Models/Requests/CreatePaymentRequest.cs: id: f8cbad88522c - last_write_checksum: sha1:cde61fa9e69b0f60aca47014504be5e01c0828b9 - pristine_git_object: f94bbce87dc758612e1c878cb19b48a393f41070 + last_write_checksum: sha1:8fc781fa5a7d2a200805f694b72f85d981f08b19 + pristine_git_object: 42d04591b0608ae5eec631645dfef2fa2d758112 Codat/Lending/Models/Requests/CreatePaymentResponse.cs: id: 39fc6cb16dd8 - last_write_checksum: sha1:f2dc7b6eae59c86856395087d9b1401176f941cb - pristine_git_object: 2d68d8bf708bb3d9b2dd6b69fe4d71091bb2e7ae + last_write_checksum: sha1:d363f4c605b343b6c45ce37091f25abda2f14f68 + pristine_git_object: 9081a1acc19dda6aa9aa4aac8d5a2caa34d12556 Codat/Lending/Models/Requests/CreateSourceAccountRequest.cs: id: 2e9653857e30 - last_write_checksum: sha1:94f196e204afd4c143d63d2eb5fc99b99f5ba4b9 - pristine_git_object: a3b130f2f7b2a3ebb0b6763ddcbd4c0893933d27 + last_write_checksum: sha1:100c5f1fbd33489f400ca1a5354ed3554ad2bc54 + pristine_git_object: 8753934ccb3ae742beda9560ebd3d12ebef68113 Codat/Lending/Models/Requests/CreateSourceAccountRequestBody.cs: id: 923b154d6cd6 - last_write_checksum: sha1:29f2328511f6872e5cdf537866d02262ca1951e9 - pristine_git_object: 9b10c238332d969273004ec18f6dec1c6e523319 + last_write_checksum: sha1:f6332f69e30ca0ba71e2d5e38a79bcdb82c4d9b8 + pristine_git_object: b7472b46fe11c2c48f81966a4c0ca7996853ebeb Codat/Lending/Models/Requests/CreateSourceAccountResponse.cs: id: 65fc09214c13 - last_write_checksum: sha1:198a9457514ec9fa1c88c52307e40d66421c000e - pristine_git_object: d94098db420cae2ab70cc75ab8262cf90546f98a + last_write_checksum: sha1:c797e426d70387cee573fbf534ea56f2d5fbffcd + pristine_git_object: 6104b042be7b648d2e0dffa24e46c43cce80b486 Codat/Lending/Models/Requests/CreateSourceAccountResponseBody.cs: id: 365a5e1157e4 - last_write_checksum: sha1:be3a7a688988002ee3dfb174cd8b407e1d77c8d0 - pristine_git_object: 3b7e80a7958f2f800f51b8ee24f96d9111119c29 + last_write_checksum: sha1:28688d7114c23e1a743b0475b19cc5e25bd2fef2 + pristine_git_object: 859514e0303fe3343bca788f36ae6f7463bd792f Codat/Lending/Models/Requests/CreateSupplierRequest.cs: id: a0249bd35c5d - last_write_checksum: sha1:3b2668a8bb7eebd1848919406ad843e622ee0b42 - pristine_git_object: 221d6d2a8b049f44cfde4bcc4efff0c72981bebe + last_write_checksum: sha1:8073d40379daa6f529077eb122285d05b30f2e85 + pristine_git_object: a1132a04837a2dc393bf093fe2b614ed08bf03b5 Codat/Lending/Models/Requests/CreateSupplierResponse.cs: id: 26574f044acf - last_write_checksum: sha1:2b2ed2d3f02ef276e1cb1c73415adaefcb418a52 - pristine_git_object: a4b65864ac5572ce2d7886a174917dbd1ebc06c3 + last_write_checksum: sha1:61d07e1398191d6f5c8701d5fd6a3c7e197c8e0f + pristine_git_object: c16618287cb60cb5e302476b57b874ed4fb0a4f0 Codat/Lending/Models/Requests/CreateTransferRequest.cs: id: 68097da9c619 - last_write_checksum: sha1:7e8f1fbfcf9e6e85d53b7c3d349971167815f3bb - pristine_git_object: 6bac05ecddaf7a3b784041d2a98b5dec1ba98c3a + last_write_checksum: sha1:9436783cbb9785d9283ea6fa40489286162661fc + pristine_git_object: 774de836ba10464f6bbae1b989e6c3b637249be2 Codat/Lending/Models/Requests/CreateTransferResponse.cs: id: 0d26875ed457 - last_write_checksum: sha1:593a1a89e91b7911cdeef4b8097d9ed116eef837 - pristine_git_object: a88d547cc76e7e6b45836ad5ea6055fe30d13302 + last_write_checksum: sha1:cb5b81acfc3668bd13e9487497e13696cbbf0554 + pristine_git_object: d738bf3f45035f7dafbf1ac8022591370b622e2f Codat/Lending/Models/Requests/DeleteCompanyRequest.cs: id: 30b541b30694 - last_write_checksum: sha1:8a9bac6d225b03edd08cc8f985216b75213bcfba - pristine_git_object: c146b9dbff8ac1d1eb901e3c6249b2dc5a67fb16 + last_write_checksum: sha1:de7d67e4f2308cbeee0aa45538dddf003488963c + pristine_git_object: d6c3e53dc478c69c5ca57a30dfde3b48c8c6bfa1 Codat/Lending/Models/Requests/DeleteCompanyResponse.cs: id: 90f4d15a43e4 - last_write_checksum: sha1:ce74abda7d8108179d9929ce257d9d66243aa315 - pristine_git_object: abd831a30de053d7cc47ef8c4841cfff3ea32871 + last_write_checksum: sha1:f78da3cfcfad4d99c946e18002e35900657079c4 + pristine_git_object: cf0205bf49a8b4a32b9a3a4d5fea0f28bde23c6e Codat/Lending/Models/Requests/DeleteConnectionRequest.cs: id: 98e5e20d5b63 - last_write_checksum: sha1:d613a95717c660c4c6f15a14f304342851f4e18c - pristine_git_object: 2f4a339ab658f3bff697e3b6f0619caa97f27522 + last_write_checksum: sha1:82a6d0dcb485e17b116b8df2bff40e6ea0a10797 + pristine_git_object: 41be064ac95c66ec042e9252b5de37973257d555 Codat/Lending/Models/Requests/DeleteConnectionResponse.cs: id: cfbea8941b85 - last_write_checksum: sha1:00afdef3f15758d579440d9d8d18f3388e72ad61 - pristine_git_object: 1c3fc64f84d7e3299cec53f539d5693653dba307 + last_write_checksum: sha1:6a8e732302efdf2c9466633ccc5e30e3d7876fda + pristine_git_object: 913a67f6d3083d420f2e677c514e7f551b868fd3 Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentRequest.cs: id: 5995656e86da - last_write_checksum: sha1:97b364a66bad665cc6ab3d4db66b15263e434511 - pristine_git_object: af1a1edfb371a6e5bf1c682c0047778a0f685950 + last_write_checksum: sha1:f50da9422acdd4ea30fe7ee975e84a597af0786d + pristine_git_object: ff7b04ecefaf423514929346f956d5f6620fa7e2 Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentResponse.cs: id: b61f35f62da2 - last_write_checksum: sha1:36adcc3022da8520ef5614e1019fb03599eefab8 - pristine_git_object: 1c270dfdd9c5765a1bd4da696bb6fc354ec05811 + last_write_checksum: sha1:415c7049638d05ae6f6cfdbe2d06def2641ade60 + pristine_git_object: b593e61090af9518b54418203d7fb7bfa98136ac Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentRequest.cs: id: 895c28eb3b88 - last_write_checksum: sha1:9672bc152c0302f00a2b8d08e475d54f8b7696f4 - pristine_git_object: 8998779d6d0e213674c3fa29b0a2620a5d3f2f65 + last_write_checksum: sha1:f5e338675ab59294bf8aa8bd2159c056308f48aa + pristine_git_object: ed085e4eb8e4353b4871c515687fb14e0d7d07a3 Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentResponse.cs: id: bab5195cb3a8 - last_write_checksum: sha1:999e707c3a32dd06aaef82afc54a56e1ce0442b7 - pristine_git_object: 80fedfc1a9203149fc18028d4a013abeebf64a9b + last_write_checksum: sha1:d3deff1d97d482c79792271a44d01df742dd1c09 + pristine_git_object: 732f0e57ed9c68b35188181f2aec12d680b9ed20 Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.cs: id: 524c1c0c8697 - last_write_checksum: sha1:6e24221e9ef5eb5c78f66f04c8b182e16f77c611 - pristine_git_object: 1c31be926fd9fe9d628414f967bcb967b2cad2bc + last_write_checksum: sha1:800711389c15fbfe3bce5c09dc7765cf2519cf50 + pristine_git_object: 321eddd89a17aba9177163412c626b5bbe429edf Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentResponse.cs: id: eb78eab580db - last_write_checksum: sha1:8afd77aff1226d0882c24cfb8d89c2bf47f2b08f - pristine_git_object: b636ff77d0ae84953840fb87ad73e854acdb8007 + last_write_checksum: sha1:42d5cc4f9f21a8e0177452e9a6733b8889cc6f8b + pristine_git_object: 1dec17970d1f0441f52a6c92d89edc1af763badf Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.cs: id: 8b6ad25b6e3b - last_write_checksum: sha1:7613cbcabbf82011f22817a154b889ff51b7b969 - pristine_git_object: a39b13fefe1168f998a33512fee7613ef6415c70 + last_write_checksum: sha1:268fc55e517a6e79e779ffadbd2015baca58886b + pristine_git_object: 5f2fe697a0ecee6b4ac032c80cff61e71c7f5cc8 Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentResponse.cs: id: 2c9ebc2b3f06 - last_write_checksum: sha1:05402d2ea7e94573a11d4867d1218b23a191984e - pristine_git_object: da8617ac2f08ec217d0b5e7360205d84c66d40a2 + last_write_checksum: sha1:53ea987d1acb3d08267d28b056c891ee8f8431c5 + pristine_git_object: b272ead5b5711225ae450e5ade9b6d949cf55e74 Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.cs: id: 628454d23fb6 - last_write_checksum: sha1:2cd6cdc9deb9e7929766a17429c1edc361b66d77 - pristine_git_object: 9fa47af85f0a63341ed8759363d2bcab74b428b2 + last_write_checksum: sha1:1ae94f70d07017f49e75776ba066ef5c7e69eae0 + pristine_git_object: cf4e3962cc36b6fca0787a7f3c4fa1277bd31aa4 Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentResponse.cs: id: db60d85956cb - last_write_checksum: sha1:1e76121081d122da1efd7f7471e58da81b2cbf8e - pristine_git_object: bef8e637bfd6f8a9ec36becad21e6ce4504f3e29 + last_write_checksum: sha1:caab119a6865d3ee90ed36c8db48e83e4e16f0a1 + pristine_git_object: e55d99a1809a44eeb44cc51a07d8f0c3114b265e Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfRequest.cs: id: 910957a189e3 - last_write_checksum: sha1:6cbef37f0085308f30544cf32e1597a8f55be477 - pristine_git_object: 8dd5b1a9025f07dff4858004b5c7b4a53487ed3c + last_write_checksum: sha1:7839270f0f50963c6367a7c04439755d93c3fbc2 + pristine_git_object: bb7c65e68768d6984669f8c130a42f3e06d5a6fe Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfResponse.cs: id: b54e37402f01 - last_write_checksum: sha1:bde2aac4ace22f20d09ec0ad1adf5ed4ddfb3754 - pristine_git_object: 90738b99ec219ede9b25b52d8058413f355348f7 + last_write_checksum: sha1:90bceef8795e947fbddcf62e117ec4a364b7f9d4 + pristine_git_object: 8037a3226f36c25ebf576f48175f1d409b4826bb Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentRequest.cs: id: 7eb8e27e7527 - last_write_checksum: sha1:a2372f35e080ffa9210d2f1f94151b1489e58ac8 - pristine_git_object: 43d7dafd57eecc100d9a6f6c96e0dbbee82237e3 + last_write_checksum: sha1:11a5ee058debc041f07f9525c1522babdfbba26b + pristine_git_object: f29ac4f34fbeee5cd4604b21081db48428a4e285 Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentResponse.cs: id: eaca844cf366 - last_write_checksum: sha1:2b65ddcdfaaeccc697f80e85b903b1e483870fc8 - pristine_git_object: c2f5da23c13f733dc2c5eb2221fe0aa350a834d1 + last_write_checksum: sha1:3e4180500505c877dec51f121ec76cbe73428335 + pristine_git_object: 138d7bf2a7d6f8e061591ff7bfbca50d29bd77d5 Codat/Lending/Models/Requests/DownloadExcelReportRequest.cs: id: e5e6d6bb63fc - last_write_checksum: sha1:d90502188186bbfda7d7cdd9d7f56835045cd175 - pristine_git_object: d060bd70fc2ff613f074d845492cbaf4cc364663 + last_write_checksum: sha1:d865d4c251179bf753a1f1a5899ca94ddcca14ec + pristine_git_object: 4e66e88c54498bfe706fedd799c1e8ea890fd22b Codat/Lending/Models/Requests/DownloadExcelReportResponse.cs: id: 35f75c14d50e - last_write_checksum: sha1:9f499463de134490da7f95883726083cb169932a - pristine_git_object: 7c32f2bdce9301cd97528dc0a4f055e4aba7145e + last_write_checksum: sha1:1c20ed9b87bcf549a8de988ab6ef2045b3988d3b + pristine_git_object: 8afad233ccb907182e25c726beda54fd1a1c9d19 Codat/Lending/Models/Requests/DownloadFilesRequest.cs: id: 6806326f3cba - last_write_checksum: sha1:14de62f73f100756579fd1661c0bcb853f9bd2ee - pristine_git_object: 39aa51d12b8ca4cf5cacd3886f22603c497c3310 + last_write_checksum: sha1:9fc392a3cfadcf82528b2a2000b92e9795815861 + pristine_git_object: c58ee0851205668c182aca1105609343fa44e261 Codat/Lending/Models/Requests/DownloadFilesResponse.cs: id: 452b32575176 - last_write_checksum: sha1:f4a6d9a6d03887dab4836291307da455989f4b14 - pristine_git_object: f57f4e261829b914e1fdfde445a10cfebe4aa835 + last_write_checksum: sha1:501fbde4d4cb3ac3ae38c3b9f2cde62fb20c6a3f + pristine_git_object: 4250c9e0e0c56b49db8456d8441eda88e6b264bc Codat/Lending/Models/Requests/EndBankStatementUploadSessionRequest.cs: id: 8aa9409b1773 - last_write_checksum: sha1:9783dada9ac0eb0de5c3e16f77ca315a74cae1d7 - pristine_git_object: 03907d3b92b08082822f4279ce475319c4842116 + last_write_checksum: sha1:0a75b5ffc179226fdbc5f30cc416ee1943973b3e + pristine_git_object: ccb5953713338b7bdb809ae04d89229edac4a938 Codat/Lending/Models/Requests/EndBankStatementUploadSessionResponse.cs: id: 789a2aa91d80 - last_write_checksum: sha1:719e4d9faee5872cfb229fb839fa640912fb7f3e - pristine_git_object: b8738a193665ea733c330399b2e09bab64e8e5e5 + last_write_checksum: sha1:fdc8dbff17a96f2cc15bf05b402588a2b33d8074 + pristine_git_object: ddc918f51826bcd0faf9c5ae372009c9f959dc56 Codat/Lending/Models/Requests/GenerateExcelReportRequest.cs: id: 092e21226933 - last_write_checksum: sha1:e94f15675e617da564d99d205d07a0c38bec12cf - pristine_git_object: d496aaa578b6a06d2c66d4c4e413a77328c093b3 + last_write_checksum: sha1:45b13067a1f62a7f110e2e83c2b89fe5538d27ca + pristine_git_object: 6b541626b21605321bd1e4aaf054f85d8d18f14b Codat/Lending/Models/Requests/GenerateExcelReportResponse.cs: id: e788fb8fe693 - last_write_checksum: sha1:249fe4072b4028868767128ef7fa1f430f2147f5 - pristine_git_object: 1790f30599d2c4ca1f007b11fdaf8f88b8c98e35 + last_write_checksum: sha1:78cc21635f0de9e8581205b8f1eb38907bfa58b6 + pristine_git_object: 8062dad7b232e872d358b57207f8b10b47e0ac3a Codat/Lending/Models/Requests/GenerateLoanSummaryQueryParamSourceType.cs: id: 675ee2349068 - last_write_checksum: sha1:dd441228231903efb84aefc3bc14355748b69024 - pristine_git_object: a149ef97aa1597d91b8883c3b750dd08155ea20f + last_write_checksum: sha1:b17a87f911b83e402ab572dafc7860ea86b6281b + pristine_git_object: a23a8aca28125301cdb04db358b1031e5438e5d0 Codat/Lending/Models/Requests/GenerateLoanSummaryRequest.cs: id: a7e2ea9648cd - last_write_checksum: sha1:f205e60a15bb77e2b84c9816dbfc35b932547fdd - pristine_git_object: dabe7db8b3a91978829fcdd8fdd23daabb8db2cf + last_write_checksum: sha1:71a3ba67775e7c511c4f9f4cab052d3dd5167d7b + pristine_git_object: 10c0e3860b983bd780d5866bd9a9f641a6a83c1f Codat/Lending/Models/Requests/GenerateLoanSummaryResponse.cs: id: 0f4a802991db - last_write_checksum: sha1:2408a1646f5f763903671d1c563ad2eb6ac41f9d - pristine_git_object: 30e14c712cdfbc78985b71d7612c6a1101f8e53b + last_write_checksum: sha1:efc45c7009eaf0fab2372d9aeda1c09b41ca0daa + pristine_git_object: dff008d547664efc982267dc8a3e885ed3228b52 Codat/Lending/Models/Requests/GenerateLoanTransactionsRequest.cs: id: cc6b70a75489 - last_write_checksum: sha1:64bf272cd3b2a24fcf4125a91bd375dd4328ff8b - pristine_git_object: 6a3582ae0d6fcd225c2853f32dd5333730781fd2 + last_write_checksum: sha1:7d9df236593c047a2c570735b47a21020c455b23 + pristine_git_object: ff72fb78fae35872b683ff1498485b10e085a964 Codat/Lending/Models/Requests/GenerateLoanTransactionsResponse.cs: id: dac554f87314 - last_write_checksum: sha1:ce4e3d7dc91b0f566584e941e7cf46f33364ed40 - pristine_git_object: 1178aa418b2f056233d496742617f67c5412f251 + last_write_checksum: sha1:e5eb6a721201adae9e8c229660e049009c02e4da + pristine_git_object: cc9eff7e2bd2de43d35e0e2bb5243b282c9fc58e Codat/Lending/Models/Requests/GenerateReportRequest.cs: id: 22015fc4a03d - last_write_checksum: sha1:20476d251ad5c5d0b2cbee6e8baccfadeaf0e502 - pristine_git_object: 3b4a2d72e7a8184488b1fce95f58892f653d599d + last_write_checksum: sha1:dfe0c25aede57514b20bd0f4c99c1d6b7fb315f0 + pristine_git_object: afe783b61c26d38d7a839ea329b73dfa201f9d4e Codat/Lending/Models/Requests/GenerateReportResponse.cs: id: e384eedbb384 - last_write_checksum: sha1:920c24afd5b2fee6b33e14e46d8200d91f839846 - pristine_git_object: b23fd6197c927a7533d91243442737da42eb8004 + last_write_checksum: sha1:bdcf9d383c15b207a1b1882fcd72bf9d27cb3f6e + pristine_git_object: 1b45219fd46d597184415f35a2fe7eebcbfbae16 Codat/Lending/Models/Requests/GetAccountingAccountRequest.cs: id: 276f584c9bd2 - last_write_checksum: sha1:170fc76fe39bb27103b663ff5f97069c1b8a5fae - pristine_git_object: 536b519937ee0b6a2256490733ca24590fd67c09 + last_write_checksum: sha1:687041dfbba9852e9b3f7b15b2eae1cd4a4770e9 + pristine_git_object: 805f2391c3f59ef74728164922fdb81ca998e64c Codat/Lending/Models/Requests/GetAccountingAccountResponse.cs: id: 0231951f6b6e - last_write_checksum: sha1:9794bcd128e987c1e14f9b7eaa0031fc7d600879 - pristine_git_object: f0330a917e70dd3e0a9a1af825168e2fa7472496 + last_write_checksum: sha1:184fe2ec0a2a1800c8f4ff6eb598ba7655ca34ad + pristine_git_object: 175ff65b749d4f5a5ce0e7f0baf890f8b90f17b4 Codat/Lending/Models/Requests/GetAccountingAccountTransactionRequest.cs: id: f0ad3ead3162 - last_write_checksum: sha1:d053ace24623ccb530d01f3fcf5eabc18ddd3fee - pristine_git_object: 52d7dce69289905403294121a2d4a8b7876329d0 + last_write_checksum: sha1:db4091c54145e03cc024e461dbc26314af5b6f3c + pristine_git_object: b9b7d473026dbcd9a7d8f1a262d94829676e12f9 Codat/Lending/Models/Requests/GetAccountingAccountTransactionResponse.cs: id: 18791bca9fff - last_write_checksum: sha1:dbcb30382ef1a5504dc0f8e9ef6deffafd865540 - pristine_git_object: 53c145ee44bb0ea6e4ab19956b094b9b5613da90 + last_write_checksum: sha1:3db1e98c90d57e74c16ba9e8bc6f24cb2a971ace + pristine_git_object: 4c8d0959b17d003415ec1517c0814eb423cae322 Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportRequest.cs: id: d3e77ea35d0d - last_write_checksum: sha1:a6ff631ad0cea732291d6a11f67ce0d6fe95ced2 - pristine_git_object: 7e3271c59fb3d065bd8448d0061e2f246e161fd5 + last_write_checksum: sha1:52103937b9c1f451f9089d6a8bc074f036adcd97 + pristine_git_object: 5671187c8acb8350943d05afe55739468b327d01 Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportResponse.cs: id: 8cde72673199 - last_write_checksum: sha1:7b7c470a4be6bf04ee506a6a8b111668eab84cab - pristine_git_object: 10acadd845f334e5c74e89a01dab7cfdcbbcb3ac + last_write_checksum: sha1:dc21d771da5ad550de4ce6c68cc99e6c3e0b946d + pristine_git_object: 7fbcd309c56b08d547c65d26327b2c65e98311a2 Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportRequest.cs: id: d7d427b73f8b - last_write_checksum: sha1:ad29807a697fcd799c30b5ed35a9e98bf3b23657 - pristine_git_object: 509fd909b954515a87a6de021b5b7aa08bd06be1 + last_write_checksum: sha1:3f001ecd9f740116ab7841959b918a2378cc218c + pristine_git_object: 8a8839b23934b279274de2af1dcf7565e96c89ef Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportResponse.cs: id: 2b7928c0dedc - last_write_checksum: sha1:991b48b35340ede3ae7b33895ba89517ead32ca0 - pristine_git_object: 18f84707f6bcd5ef89961201e8dae937d66b8918 + last_write_checksum: sha1:81e7a1a4eb7a5a3409ff760363816389c453d633 + pristine_git_object: c98500159d3ba4f7705e8099b65022bd61aee383 Codat/Lending/Models/Requests/GetAccountingBalanceSheetRequest.cs: id: 3095c4fafd92 - last_write_checksum: sha1:2dc57be2e1d4ecc904711d8bcdd7485c610032b8 - pristine_git_object: 83a154e3733b30049878d681f285d96b9fbeb50c + last_write_checksum: sha1:026aa00a10483db86d83d70516705cec7ad3a7a3 + pristine_git_object: 6d7630a839a22ee28af31f269d7fa43538402e99 Codat/Lending/Models/Requests/GetAccountingBalanceSheetResponse.cs: id: 5a481a0c6e5e - last_write_checksum: sha1:c6194956baa6c8d48ae169aba6eee32def985a1e - pristine_git_object: 856a2e8f1b4a6bdd7b9f38a1f32c17171a20e2d0 + last_write_checksum: sha1:e02363cb449def9dfc6aa11dea45af705e020957 + pristine_git_object: 091ea97d1902d7ec84f61ca98e3d4417d9637023 Codat/Lending/Models/Requests/GetAccountingBankAccountRequest.cs: id: 2105f744dd7e - last_write_checksum: sha1:f574a63e0d67559480295630d4d138ee1013feaa - pristine_git_object: fa215bcbf725fa3903b48180e739d62cc9337add + last_write_checksum: sha1:ab2573ba3639dbf93a6f8cb72892526405a34567 + pristine_git_object: e9ca960eba3874fbc764dab10e2a0287b5c74f7b Codat/Lending/Models/Requests/GetAccountingBankAccountResponse.cs: id: 85a424c837c6 - last_write_checksum: sha1:7ffdc5fc5092a22a1654345d3bc581169d1e023a - pristine_git_object: 16bc75b62cc9764dbeb3af40122823f55e2e4327 + last_write_checksum: sha1:9d88df478a0f006ea1b9ba38eabef2660ebb540d + pristine_git_object: a97c5fc475ebba5ddfb9d283da21d0759ceb0f48 Codat/Lending/Models/Requests/GetAccountingBillAttachmentRequest.cs: id: 1f3dfe197086 - last_write_checksum: sha1:6f1980c54d376cf8230cd9dd0fe22346f3e1489e - pristine_git_object: aaf2b0e5b1d24b224678e17765faf4ce27022f62 + last_write_checksum: sha1:cf49549beff19be674dc035a308ce50c32f97051 + pristine_git_object: fe3087885b5ad644fd1fa82dae213e45287ce746 Codat/Lending/Models/Requests/GetAccountingBillAttachmentResponse.cs: id: 35fc48691573 - last_write_checksum: sha1:384f6491061e73c37ed3e904a14cf75d09adc309 - pristine_git_object: 8f04bcb43807344f4f5e885f6f21adf3ddd6cd7a + last_write_checksum: sha1:684f0398960e9b00b13a60e6402ba94b0292e15e + pristine_git_object: 740bbbbfc28b07665f7b44e561764d99773a40db Codat/Lending/Models/Requests/GetAccountingBillCreditNoteRequest.cs: id: e5d6dc4a0df9 - last_write_checksum: sha1:963fab3cd92c23387e9b46efa918bf2712b82b8c - pristine_git_object: 4f979e0ab33b1048c003454f0fc2469ddbb4bbb1 + last_write_checksum: sha1:2e2c2c19d995b13684e070192260b0250054cbb6 + pristine_git_object: 559ed62ac49c9b64eb869588663f4c06efec1b49 Codat/Lending/Models/Requests/GetAccountingBillCreditNoteResponse.cs: id: 392abd979c59 - last_write_checksum: sha1:fd0954724f9c04c6ce1aa1d86a70831824cebab1 - pristine_git_object: 16541af2867addff5c17b8c7c0d60fd17574a2df + last_write_checksum: sha1:8c904244a9c437f498b029c75e98f699a4188675 + pristine_git_object: 97d91cdce291042f36fa3eadd12ed41709280fc2 Codat/Lending/Models/Requests/GetAccountingBillPaymentRequest.cs: id: b1609ff8a4c9 - last_write_checksum: sha1:dc17fe29a8cb0bb8a9ba6eaa07572e04c290571a - pristine_git_object: 6243e908c43da60a2cf98fbd7a780a1ef8d6ceff + last_write_checksum: sha1:a1ca0c13ac2201aeb1f68bc589588b0f34535a32 + pristine_git_object: 0d366b74727ce49280c0824b84a0b472d64b0ec7 Codat/Lending/Models/Requests/GetAccountingBillPaymentResponse.cs: id: dc1100ff522f - last_write_checksum: sha1:9075b0ae8157397d14d3fece21f459c4a6e1d32d - pristine_git_object: f430546af27ae506248d7cb4d8a54298adbf2bff + last_write_checksum: sha1:e0b6d74f5125cb468d0dc4c6932cbb08693fa6ae + pristine_git_object: f6708efcd84be0d8338babfc72023dd87e447dc3 Codat/Lending/Models/Requests/GetAccountingBillRequest.cs: id: 6eed9ee185c3 - last_write_checksum: sha1:7475c54775b67195091ea3394d4cd4deedb3d230 - pristine_git_object: 2c39a26426f137909a6a31f49577a6567eba17bd + last_write_checksum: sha1:c2362442d996fee05672a442e8ca773f1fffb83b + pristine_git_object: 24302d3cb17899418d5e18e9b2c5c9e2ac95ea6b Codat/Lending/Models/Requests/GetAccountingBillResponse.cs: id: 267962f1e037 - last_write_checksum: sha1:3d41970936ef87111663457a30eac6cc4d7d5d5a - pristine_git_object: e361c699f05ce726b253e7a14137cfe16feb026b + last_write_checksum: sha1:0616399db2d9459c9da25c57eb0a48a512b83d36 + pristine_git_object: 4278de9621012b8b5f6e4551ba44a742e47f2cc1 Codat/Lending/Models/Requests/GetAccountingCashFlowStatementRequest.cs: id: d4a1a29a3378 - last_write_checksum: sha1:451cacf741d9cfa109969381be016ca2f669f9c0 - pristine_git_object: 62e4e7cdd51c1201d6dda1b76e0ac2e7aeedf904 + last_write_checksum: sha1:a176edb3ac6ce8d11065b80a4369c3877bbffb92 + pristine_git_object: a312f5e622d9c6526325f03cb47e1345d77fdaef Codat/Lending/Models/Requests/GetAccountingCashFlowStatementResponse.cs: id: 4fda370bbab8 - last_write_checksum: sha1:5db3be4d3d6ee289922ef5d70d5fefd4be982653 - pristine_git_object: ee0587999a77552e1bb8329070f0ad6f785a5178 + last_write_checksum: sha1:36fb395c2bbb26fbf44523bd83205c37a7ade7dd + pristine_git_object: 7a6b2bdd92106924d80f938fae430ef9a5d320b9 Codat/Lending/Models/Requests/GetAccountingCreditNoteRequest.cs: id: 7684f070b0e6 - last_write_checksum: sha1:faccb3881b6184b8ff610c490e4573fe533a72c1 - pristine_git_object: 7a2d2f420d4c109210eab05adca275757d4afe9c + last_write_checksum: sha1:af349a36af88220da1fb471675743cc6956090e6 + pristine_git_object: d372bc485b949f4d83eb89410f3c46533350922e Codat/Lending/Models/Requests/GetAccountingCreditNoteResponse.cs: id: cf7264386478 - last_write_checksum: sha1:179f1d4984b049a61909c79ffb5e6e3a47538f4b - pristine_git_object: 1777e8ef828acafdf72983c56e4b48cee1615c26 + last_write_checksum: sha1:52580609b6355f2f900766ce4cd8cf96e6046028 + pristine_git_object: d77bb7574da4aa6c9ad114a0149c246213e9d8e3 Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentRequest.cs: id: 77326bcbbb21 - last_write_checksum: sha1:b40a0fd5f5a4362daa7e084dccf1b605c8907706 - pristine_git_object: eadc40f30b968b31ffef351d04ed4dd05be3260c + last_write_checksum: sha1:a57e583331e9576334dd2541c3a8bcd4cccf3d15 + pristine_git_object: abaae38a542bf3251b6ec17cb115b2ec6edb03de Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentResponse.cs: id: 78a267f6f058 - last_write_checksum: sha1:5468a822d29158707937252eb7e8bc58a402b73d - pristine_git_object: c21068b76e9a1337b805058eec8626b5eb6b7ed3 + last_write_checksum: sha1:046ea51e56138aaf600056e2848c672c960d15bb + pristine_git_object: 244cc65958813eb1501cda49290643db96f2a3e0 Codat/Lending/Models/Requests/GetAccountingCustomerRequest.cs: id: d40b69d2e3d4 - last_write_checksum: sha1:d8d52400b1502fa95cdfe68aa82e253d4be1abcc - pristine_git_object: 9222242be527fd1754fecbce610aa71018ea2aed + last_write_checksum: sha1:fdf4c0fe94c66f0e143f0b03f00400c3634f6282 + pristine_git_object: 15558fb6fbfec3246e9f5e3c1f8a0c0db94eb630 Codat/Lending/Models/Requests/GetAccountingCustomerResponse.cs: id: 630bbdfccdd3 - last_write_checksum: sha1:76127f29e245b4ad4be1b5f7333601285ece3f42 - pristine_git_object: 421b29dbd3c79d02082129111573807891724008 + last_write_checksum: sha1:8128f608558accb03c1abaa60e2245cd46e0d560 + pristine_git_object: 983df949b37b26ce1685a2b6c91470b1ef710e2d Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentRequest.cs: id: 8d743ebe8815 - last_write_checksum: sha1:cd44fc18e6ecebb88ad107cd8bea3c9a2aea1efc - pristine_git_object: bb1174534cc62cf3dd78b7079c1f15f9e3c44830 + last_write_checksum: sha1:0020625f35df8cdba179144edc8ac40128d3cffe + pristine_git_object: 067ab32a180795ac285c0f5c1fbb07f08f3ea657 Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentResponse.cs: id: 9ae7259f66e8 - last_write_checksum: sha1:6c150a95eedb4ed99881091a1c9f3776826bcc5d - pristine_git_object: 14b92811751bc33aa937548ff2506f80a1ef8a18 + last_write_checksum: sha1:b1e26c18fd7563b4ff8d65932f4ed5ca9c0775e9 + pristine_git_object: 0b92775ae0d974f16aef4803c123fc7aae16352f Codat/Lending/Models/Requests/GetAccountingDirectCostRequest.cs: id: a7aecb175c15 - last_write_checksum: sha1:ef4ae962469786dd61d9141001f6c0e5a58b030b - pristine_git_object: 6e29a13db8bc4406e6dead1022e3721f86b9da9a + last_write_checksum: sha1:054b7c7192854276c4ec84c759a8a74dcf099e18 + pristine_git_object: 42c7de2eb03747e190965643b1e8485440165518 Codat/Lending/Models/Requests/GetAccountingDirectCostResponse.cs: id: 4b69d4561787 - last_write_checksum: sha1:5c4b2ab5e136b9e9441f27e7248be98a70dd3234 - pristine_git_object: 756ad74b30aec4eb22ac4d8606ab1f521114c3e6 + last_write_checksum: sha1:5ee1cd679bab174d1bdb498f9848eda7b0efd7b0 + pristine_git_object: e3cedd9f899c344b17b58b88889b1e8e9011de56 Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.cs: id: 91b97a12d1e7 - last_write_checksum: sha1:b5d30b8497d12eda13b5bb63bc7ae7f82692ddd9 - pristine_git_object: 10ee23c3e6a7f17d11ad5e2dec7c8f9fc3ef95f7 + last_write_checksum: sha1:9bc9f9deda66e7739c04b9b97e5b58cf9af9c924 + pristine_git_object: 03304ab53527e81073dd8509c3428b0fa31709ec Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentResponse.cs: id: f188caabd880 - last_write_checksum: sha1:689a1fd0232d21e4b261ea896cea786697e0375f - pristine_git_object: a1212c62d3b2f7d257634203cfbc049ea82f2eac + last_write_checksum: sha1:36faf0ebd4c98eb796145ac1b72ba6758cb0a210 + pristine_git_object: ea3685198d4966102a1beca4047e3dce37ead417 Codat/Lending/Models/Requests/GetAccountingDirectIncomeRequest.cs: id: 1734dd73fb2a - last_write_checksum: sha1:6dad8039e7e87aec124a1c8956ed8c111596e5a0 - pristine_git_object: 20272b4bc4d69bcc6ab1bb78a49ca55e9cec77c1 + last_write_checksum: sha1:5d4fb284086a739664b4ac5fa89477c2995840be + pristine_git_object: 91644bffc10a91ce8fe56cbb34d7ee0bab3f4d98 Codat/Lending/Models/Requests/GetAccountingDirectIncomeResponse.cs: id: 9f4484172255 - last_write_checksum: sha1:3c4b2a9aa263829f6f76101d033d128ff625ba35 - pristine_git_object: 982fc862ea7eb6c0ee7aa3ee1b11ae96ad79dd32 + last_write_checksum: sha1:84c6f48af17134741483fb83e6a2d571800762e4 + pristine_git_object: 6661a58b4777d2ac57aecd300ec384a49762e1c7 Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentRequest.cs: id: ed708fa2d4bf - last_write_checksum: sha1:894b5589837b73721859c9123237325b7241c652 - pristine_git_object: 50f5f0183d242a3b7188dc962c14d386dede8b71 + last_write_checksum: sha1:e416e2728aba77967f1aeeb0881d58d5de968ea7 + pristine_git_object: eac309425a89986746c99871d2a73733eb34b1f2 Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentResponse.cs: id: 95af73e7ae50 - last_write_checksum: sha1:3f9cbc3c8eca68ff12637b83ff3974ac71710bb6 - pristine_git_object: 506989ee5936199b0a46c0e040ec6feac752d7e7 + last_write_checksum: sha1:3056b776e3f436708b468d14ef319f4307442955 + pristine_git_object: 64bdf474e94ada8bcb1143c2cb42dc665071a70a Codat/Lending/Models/Requests/GetAccountingInvoiceRequest.cs: id: 5f529e68da05 - last_write_checksum: sha1:f2737278f43db94bbc67cecac8969442bbe37c37 - pristine_git_object: 9f5e0a5b457d0ab037d59c624d957740578480fe + last_write_checksum: sha1:8788cb61a267b09a230e6fad6b319796df9c0443 + pristine_git_object: ae90378edf4c6574aa09072284570f7bfbe5cfc3 Codat/Lending/Models/Requests/GetAccountingInvoiceResponse.cs: id: 67b04736bbb4 - last_write_checksum: sha1:38e6ac84af0dc193fe8994dd79fe58551df0e00d - pristine_git_object: b11daa392f2574a04e57d9e5ca5f13b7cdd63fd6 + last_write_checksum: sha1:41a0c0d168c3b9a953b7d3a7e6ece247b15cc5c7 + pristine_git_object: 5030c301a1bc81c599997ff0b9ea93d92cb6b41b Codat/Lending/Models/Requests/GetAccountingJournalEntryRequest.cs: id: 478d59fd6544 - last_write_checksum: sha1:afa7b127651fc1facf86fb99d6d5205278d5ee26 - pristine_git_object: b1da26f72e42302b19de489bbd6e973cb70fe3f0 + last_write_checksum: sha1:1224c1625921f8d70b84abeca3a9459b3e4956da + pristine_git_object: 41e3cd8685a9c1456e6de16c5d4d067ffcede044 Codat/Lending/Models/Requests/GetAccountingJournalEntryResponse.cs: id: 5200aecb2bdc - last_write_checksum: sha1:a90d3fdce37cc88f3bbbb0582348cb2299049fa9 - pristine_git_object: 2090886d16626a8b66d1ed2bbdc9948e8df11c0b + last_write_checksum: sha1:6cb37f4aa4b122995cd710711d6a204d5bb54f00 + pristine_git_object: 91b3de48caf61ce6f56a1fbb666626d1166e0194 Codat/Lending/Models/Requests/GetAccountingJournalRequest.cs: id: e91a327d7364 - last_write_checksum: sha1:577e6a000a9c6dc07b3b6595eb8813d628d36a1e - pristine_git_object: 69a13bff0ae16b474fb1fd8eb4287c6558947307 + last_write_checksum: sha1:c7c25d05773282fac8dbdd2bf2fc18d532327d26 + pristine_git_object: 13b0ca2ab4d6619901deb6ffb33b40a7720cb9fd Codat/Lending/Models/Requests/GetAccountingJournalResponse.cs: id: d7fe41782cca - last_write_checksum: sha1:9e82707c04679fd528237c73ba7ce95a750417dd - pristine_git_object: a59fe5aca907de9da1fa54c3d2b036850d64756b + last_write_checksum: sha1:d806d02386005c3bd7c7cb3b65c7058ba0fb8e38 + pristine_git_object: 29c7c85a9985419e32d247908e53a0fda3f66f42 Codat/Lending/Models/Requests/GetAccountingPaymentRequest.cs: id: 232bf4973629 - last_write_checksum: sha1:4e26483e23720844efe183552224a6fae04f1f1a - pristine_git_object: 0f3d081f462c708122b2810115edda659da4ce00 + last_write_checksum: sha1:df3f1c0e5d8b8d35851e9bbbddfe17734f346857 + pristine_git_object: 5a1c8558cafae714f5a41a11fe3ff4e66bc8b94c Codat/Lending/Models/Requests/GetAccountingPaymentResponse.cs: id: ddc3f0c1de63 - last_write_checksum: sha1:5b065fcddc105961f1c605d28b4449b757efc0e8 - pristine_git_object: bdbd03e64771d6c801578f547b75fa4162c84553 + last_write_checksum: sha1:ab7e2fc3782c0d5650bebaa138d4a3a5729e7eb4 + pristine_git_object: 54fc68915694b280130ac22a172bacdf142b5b38 Codat/Lending/Models/Requests/GetAccountingProfileRequest.cs: id: 7c1d4c7ac66c - last_write_checksum: sha1:e0000ed9cc4d2f3792c965113a4aa28e51592f52 - pristine_git_object: 5049fd9711c1881560238686409d4b8e57988f6b + last_write_checksum: sha1:ffc5765361e97b89ef825c4142d5f14e493badad + pristine_git_object: 137abd03c641a0fe9ff078f66f4801415bf0d8e0 Codat/Lending/Models/Requests/GetAccountingProfileResponse.cs: id: e21e9a9f147e - last_write_checksum: sha1:e4a96381e877b35169f71dd965afc1f23992324d - pristine_git_object: 3162db3c63a953f9c090879e38d6c0855b14700f + last_write_checksum: sha1:6e317c469b7dc9c62a34ec898bc18f6d1c918522 + pristine_git_object: 1f8fcc460e6d98c563d96ebc8724eac7621ba895 Codat/Lending/Models/Requests/GetAccountingProfitAndLossRequest.cs: id: 303405a58f3e - last_write_checksum: sha1:0652ca48425906d6276020596cb615e0ec71f33e - pristine_git_object: eb288fa76d4d610be51672081a11d8c3f54d7f0b + last_write_checksum: sha1:cbee9c9fc9098c25d60b205c7520f8c9c2a08d93 + pristine_git_object: 0ef26069a6bbf2ec82c8fc9c8e9f9aba7cc552d7 Codat/Lending/Models/Requests/GetAccountingProfitAndLossResponse.cs: id: 8ef2f0debbd2 - last_write_checksum: sha1:97170904941d12899a0376a71da415adc617a407 - pristine_git_object: 411dba1a24c0fac7b340816d96f2c2ad4ff82bf5 + last_write_checksum: sha1:b9ad64c9bcf9b7d728034c909dde5c8bd337ff04 + pristine_git_object: 8dcca9d370fe21ef014f00fb281de12fa4bb0e3f Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentRequest.cs: id: 0db57b2fde84 - last_write_checksum: sha1:60a62e5e92fa2bd318bc1456bb92fd6658bff413 - pristine_git_object: 6c4a1f53a6ee7c717590705e2d3d9435b16ff36c + last_write_checksum: sha1:fb7e4596e4450cc9f4173104487d8a4f85817536 + pristine_git_object: 18b9b625e820f8e82c88d6fb4438d0e71d1ea351 Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentResponse.cs: id: 66cc4868d60d - last_write_checksum: sha1:28770300b8b38dcdbec03cfcf7edbc37b3d17199 - pristine_git_object: dbbca9605adb86f5bc97898b3bfbb73fcb6beb8d + last_write_checksum: sha1:007b811cd171b509c358b4a507f88bdb206315e1 + pristine_git_object: e9722e7e675f80396af193aa1da6ba043afddf82 Codat/Lending/Models/Requests/GetAccountingSupplierRequest.cs: id: 195b79782748 - last_write_checksum: sha1:4cbeb65e7603d65c628caadfd6270d16de71a891 - pristine_git_object: f75aa3f180211f9fff87b0e84a416ef67435c703 + last_write_checksum: sha1:f7c63818613755645b22e176446fb6e38f4f7b7f + pristine_git_object: a2f2eb75bcbb96b2a628b512421f68873db612dc Codat/Lending/Models/Requests/GetAccountingSupplierResponse.cs: id: abbdec7548e8 - last_write_checksum: sha1:575e2d991f4c9147f08614f7ffa6cff20d679bca - pristine_git_object: e35e479e470fb1dd35d113fd3659998f885326b0 + last_write_checksum: sha1:04a342606ef9d1a512bda0853cfc09d4c1dc7821 + pristine_git_object: 13374b2d0d00e0a88c3ae6945e0a9df2e1074bab Codat/Lending/Models/Requests/GetAccountingTransferRequest.cs: id: d78d336dafa3 - last_write_checksum: sha1:613f7afd8a9653ac3beb6111045973cdf943ac7e - pristine_git_object: 1407ea13fe26c659035f274d22e4c8325de787bf + last_write_checksum: sha1:a36bd682fb7342f96b3a56322aeb1e689eee4bd8 + pristine_git_object: 67eb2e99546828f6d34917d16f800350a09d216a Codat/Lending/Models/Requests/GetAccountingTransferResponse.cs: id: 755fa9ef705b - last_write_checksum: sha1:17376660d74e8e8ca7b64d5391daba77c58aa37d - pristine_git_object: 505012219c1431c0f873a90d880fd67a8579c3b8 + last_write_checksum: sha1:10e89df31ae27e384234dd4ef0f7a2195ca0b440 + pristine_git_object: 8687658e1bc28067aa16198383757e68e1189617 Codat/Lending/Models/Requests/GetBankAccountMappingRequest.cs: id: bc660228241c - last_write_checksum: sha1:cdbe7fcd2001ca5ad7ea64cfe6391342afb771f9 - pristine_git_object: c8815d0304cb183e8f9aa9538f372b763806d766 + last_write_checksum: sha1:d109eedec4f6c8814ccd674984fe5d831dd6d771 + pristine_git_object: 2c5b8ab7b471d08b0a54dc3a29a9079552a59ffa Codat/Lending/Models/Requests/GetBankAccountMappingResponse.cs: id: 8b10cbc44b0c - last_write_checksum: sha1:89c08534aa651226977fcba880bd3c85389c063e - pristine_git_object: ff194b744a36e7a8ebf5b558312af0fde3adb749 + last_write_checksum: sha1:e25baab3fc1347a436d4e4b9bc943571c6ceaba0 + pristine_git_object: 21d83e00958a7a5a8e36d5823ee58d171e113184 Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationRequest.cs: id: 1771808c2d06 - last_write_checksum: sha1:5e90110493bacc6e95c4a27302a0f49936835a9d - pristine_git_object: 999eef2bef63ec27dc9ce681fd492adf777fdf49 + last_write_checksum: sha1:0a95775bbb7db3a0f4b31a776f4d9a578d5bbe23 + pristine_git_object: 0d90e62d01ceb66dc54911b681d6e2ed75f384c4 Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationResponse.cs: id: 984944a1dba5 - last_write_checksum: sha1:43021d82e3f84d8d42b443635a3212f90eb3ad45 - pristine_git_object: 5438da32f2def3eaf44e941d58bdc8abb08a3543 + last_write_checksum: sha1:0be6d97ca434d2177e30a111a006e771724e4991 + pristine_git_object: 9d8bacbb8c27cfcc118473b1843915997b08cec8 Codat/Lending/Models/Requests/GetBankingAccountRequest.cs: id: ba239da58e82 - last_write_checksum: sha1:e0ae42c1c4e78158314afe3154cf387880fb0d0b - pristine_git_object: 2ce0570647898bfba80cd8f31868f92cd073e4c9 + last_write_checksum: sha1:74d1401e05f6434838946a01353b1c309d2c3cb3 + pristine_git_object: 206553f3fc76b0285d115ae4b4d8fdd2ba337799 Codat/Lending/Models/Requests/GetBankingAccountResponse.cs: id: 41942a25101b - last_write_checksum: sha1:2127ed8631e95f67e965b89d1d89b62c4b9f03a8 - pristine_git_object: 83b421c97ada823d5ef8490b2486cb11e2f92e8a + last_write_checksum: sha1:6bd38725850a41312b790c2d58f0d86c1dfbe69f + pristine_git_object: ad1d75e15a1efd6d21ac1ea4001ff5f7e1b7414d Codat/Lending/Models/Requests/GetBankingTransactionCategoryRequest.cs: id: b52de7bc9393 - last_write_checksum: sha1:ca73591ce34ac4afe09c15458d6823deed9436e3 - pristine_git_object: 79b9d05cc21922fcf1674685f3606f21d874840a + last_write_checksum: sha1:7fd9b9e554f8fe9dea6e573b66e614b148a4daeb + pristine_git_object: 7068ff3643225b291a57c4193769ed96f84870cf Codat/Lending/Models/Requests/GetBankingTransactionCategoryResponse.cs: id: e61d1cf60c26 - last_write_checksum: sha1:a45db378c62edbc7a71d2349cdeabeba52aae998 - pristine_git_object: 31c9e9965dd63d675a55f5b6ced08f7ab5a2c4d2 + last_write_checksum: sha1:d41b186e8d6506fc9ca2b5569f007dae7a7752ed + pristine_git_object: 20783922537cf62dc2e14daf4d3627b828a89b3c Codat/Lending/Models/Requests/GetBankingTransactionRequest.cs: id: 1dc249b497b9 - last_write_checksum: sha1:9fe28a4da234a763ee8f96f72fd1b0c3150b9683 - pristine_git_object: ece9359123321cf81c7758ba94a7251ce9fce144 + last_write_checksum: sha1:1d40fdd1a9d05ba112de8e411b0fbcf3be9ee222 + pristine_git_object: 435a9cea1f404f94a3798ce02f4fe3f3fd8a84b3 Codat/Lending/Models/Requests/GetBankingTransactionResponse.cs: id: "93487782e101" - last_write_checksum: sha1:84137304025ed6ea3c62836cf32bcd1dd9448d4d - pristine_git_object: 23521a4bcf4eeb3999f7fa335ef5c421257016a4 + last_write_checksum: sha1:1b8a9ad405d0d8abaeb2b307755dbade192ef4e6 + pristine_git_object: 1c9e4467172f88ba3015fe41a3c7f098667f4c23 Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementRequest.cs: id: db9cc869ecf5 - last_write_checksum: sha1:d09366442a1c0addb1b1478bcdf3a02c78873dba - pristine_git_object: b6b06b09295cc35d6f60f15857ffa4a5f1efed34 + last_write_checksum: sha1:996a3d6d2c471071e676f9a8c740c372bbe5caea + pristine_git_object: ecb453456a0b3a29044a825dbf9758212ade1b72 Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementResponse.cs: id: f4c823eea138 - last_write_checksum: sha1:e51f58ee2a913292e65aad87d0928f7bcb5afbe6 - pristine_git_object: ebcdec5dbea5f2a57049f1c30916f0f86b9a4d17 + last_write_checksum: sha1:a44bbc27e2d8b62c0fb72d18f40e4e742995c57e + pristine_git_object: f614834fc404a9ca6e838b6e1d3431795d2a2110 Codat/Lending/Models/Requests/GetCategorizedBankStatementRequest.cs: id: 04798af22c30 - last_write_checksum: sha1:6de1f2bf281aa98da3608e176c6d764234cb09e8 - pristine_git_object: c521af4eb28fea691e3894db00b0485b760aadc2 + last_write_checksum: sha1:965b2f82f817c41f401acc0801ad7ee396bbb39a + pristine_git_object: 516c6302383d332c549929e3eb628bd579562252 Codat/Lending/Models/Requests/GetCategorizedBankStatementResponse.cs: id: daaaa16787ba - last_write_checksum: sha1:d9bba214d75148bd8ee2a8c81bab0af01ee907f7 - pristine_git_object: d0bc82c7a95f0880721b87512599efd066751a26 + last_write_checksum: sha1:97b93eeab2d448f4ac1f5261a00e1283d65b33a8 + pristine_git_object: 2cfe395116ff4f8c2ef54d2e16ff958f3310b6f8 Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementRequest.cs: id: 8997aca4b886 - last_write_checksum: sha1:c89aaba16f4695fc54075dbec08056dada49a398 - pristine_git_object: 7ea40e90fec4fc405058a7477c5fe1ad842eb84b + last_write_checksum: sha1:198ba6a99a28edba18e42c4f776aba86b5d053a4 + pristine_git_object: cfa00b3d9b1124a929970bbea45e9e800e7f4498 Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementResponse.cs: id: d66a24ce334f - last_write_checksum: sha1:d08966ff61fdc6505c6e917feea536f83f6e8419 - pristine_git_object: af7cb956d08b11b3fa5313614581ba7884f7a2b2 + last_write_checksum: sha1:96e4ccab538c1e7a3468f5306cb4a48a38aac186 + pristine_git_object: 64e360d6765ad78a0c76b6684b4e66e1c738a838 Codat/Lending/Models/Requests/GetCommerceCustomerRequest.cs: id: 0ca58209fc20 - last_write_checksum: sha1:17b05b13674e28701649f326a9c9063b4bdb53a8 - pristine_git_object: 513b89f510fcfe1dfca6afb90e178d0d684c57ea + last_write_checksum: sha1:e3870a6295939f76c9115726cf8f8485b48c5a16 + pristine_git_object: 3920a225f07dc2386a28c22b1aba014054092fc3 Codat/Lending/Models/Requests/GetCommerceCustomerResponse.cs: id: 5be7135db5b2 - last_write_checksum: sha1:052b922b6053e63aa3d7afb27d88d36d7eff80af - pristine_git_object: 6cc91fcc6f358e54d32ef313e7f11d5e010c49ee + last_write_checksum: sha1:296c0c153748bc577865a2d66b0fefddbcffb8a8 + pristine_git_object: cfc4cead78e0ca983770b16563e57409fa73cc2b Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsRequest.cs: id: 48abd99c6857 - last_write_checksum: sha1:9161981f7d6530a1c8e764ab5dadb6601de5c62c - pristine_git_object: fc944c476bdceed506439ef19bea410a8042e2c8 + last_write_checksum: sha1:70e9eea6dc26d72206bb769bdcbf946b2e76da6e + pristine_git_object: 627ae629160902465361d19f36d1ef661bada8ad Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsResponse.cs: id: 602414eded54 - last_write_checksum: sha1:804af6c7a5fa5936bd17604f83146bdf307b0cae - pristine_git_object: 14b15e52c8a0cce8a404a2c6b382a71ba0163139 + last_write_checksum: sha1:ce9be9230c9df9cf514be0ae9fa9f2deee2e73f0 + pristine_git_object: 57b2fdcb37e74cb8c5a481e1bdd0aa04d57df317 Codat/Lending/Models/Requests/GetCommerceDisputeRequest.cs: id: 9b0e6dfb27fb - last_write_checksum: sha1:4579113d84e77b59b0fde0f74a700b3c182aeacd - pristine_git_object: d479e3520e404f9a176996d7a035ab1771de0c4c + last_write_checksum: sha1:db5615d69c34d4484049c99969d3988795b5e9ad + pristine_git_object: cbd562c6d1b08156c6a11fe76a6bf2e1e2648b4b Codat/Lending/Models/Requests/GetCommerceDisputeResponse.cs: id: 3cd58bafd039 - last_write_checksum: sha1:872039c7dd2e359df45a4272ab7746ea10cd6815 - pristine_git_object: a4a9d69d2510244510b412ff7dbca71ffea5b060 + last_write_checksum: sha1:462cee19de17ef0d9aea237d0c39472e7f847225 + pristine_git_object: 3fc850304b098fd1acc5313707ebda8ae708131a Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsRequest.cs: id: b61135b83474 - last_write_checksum: sha1:24dbf320f205a0497f08a36992ce7f7f077f3d06 - pristine_git_object: 27aa750167c436a9ffab6ac05a95bf6d36f2b4ac + last_write_checksum: sha1:c0bd6404c68ddd6a17e097b23bd71c4af2720adc + pristine_git_object: 246e08c2acbf0d966518b70193334124959fbd50 Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsResponse.cs: id: d5a85d6bdcd2 - last_write_checksum: sha1:8eca694db21ee04914948634068e24809572b23f - pristine_git_object: 973a1e06cdfde2f7d8b3c52a7adc0ff364990a13 + last_write_checksum: sha1:0730fb52ec36b09add1af01badcdf900ff4daf2d + pristine_git_object: f8d2f3df620b27bb7cdeb720ed08f4d8a616b885 Codat/Lending/Models/Requests/GetCommerceLocationRequest.cs: id: 1ede2477f0f9 - last_write_checksum: sha1:5cfa030c88c0ade89fada60b35c33fdb83370cb5 - pristine_git_object: 1df2428ef43594f2264844589b71ec4f6b06630b + last_write_checksum: sha1:434816f8d6af16e362f3df3dc3f34ab131f7102a + pristine_git_object: 04bdf409726ecd85eecf64577ccc8d896ee72344 Codat/Lending/Models/Requests/GetCommerceLocationResponse.cs: id: c58a64f4bd5d - last_write_checksum: sha1:4e40b23d6e95a0c1a4d2466ac07b09dc0e399252 - pristine_git_object: d3fbe7715e82014ea1805450e022b8b108fc0e09 + last_write_checksum: sha1:f1d6e43246de6a6d37e159e51b0cb466c95915c5 + pristine_git_object: 0db469f54ee9dfe08f4cfb9f0b3d4e3459aa4972 Codat/Lending/Models/Requests/GetCommerceOrderRequest.cs: id: 242634378d5f - last_write_checksum: sha1:da2db14b5840af18412390d4246abd2919db7107 - pristine_git_object: 37d39e516eee4ed8ab5bb77182dbc87bad122735 + last_write_checksum: sha1:3720add1edae3ad11b5b8209f2092073c58e354c + pristine_git_object: 8833964cf31d729d64168a9af274e7e2227caf12 Codat/Lending/Models/Requests/GetCommerceOrderResponse.cs: id: 04cfdbe38891 - last_write_checksum: sha1:aa1860355203843e79cda769164bd018295c0fdc - pristine_git_object: 351242b1a612b3fe30bd26884c93cec03ca69f82 + last_write_checksum: sha1:c304bc38cf251908ccd622b7674b33cc0a891a61 + pristine_git_object: 8cd8bb79b9a15493dba57ec48cf21e9d80045703 Codat/Lending/Models/Requests/GetCommerceOrdersReportRequest.cs: id: 3398878f63e8 - last_write_checksum: sha1:338f3f1f310a8e0fb17de94e0dcdebb0f8c94d55 - pristine_git_object: a572e898a69953a5d3930b0b818ec7f0b3cd7047 + last_write_checksum: sha1:bfbb7ea33daad5e7cc15ef199c42f9dfcd9094a0 + pristine_git_object: 704276a26c39f93eba73bf080932087ddfb79818 Codat/Lending/Models/Requests/GetCommerceOrdersReportResponse.cs: id: 89000391a761 - last_write_checksum: sha1:89a7543dde3c4c93e6949e39dad35140ccd03717 - pristine_git_object: 30d709e7ebc90e2831b592ed2a9e82fc9174da65 + last_write_checksum: sha1:c568be8aabf8d828eefd7cd134b36e1e55ab4c4e + pristine_git_object: 8667cca89e2f93cf4dbdaa4f3e8c8f36e55b9df3 Codat/Lending/Models/Requests/GetCommercePaymentMethodRequest.cs: id: d1a4949f3673 - last_write_checksum: sha1:1492fdeba8e3ea46e485c91388b65eea3ee9cdd8 - pristine_git_object: 05a6cc8c842f6e9845bbb6dd09b7d3cc13fa3aea + last_write_checksum: sha1:a3156e9228ff02971fc5a505dd9a07294f32408f + pristine_git_object: d78d98cd3691e075359b9abcc4887bd8cec5f513 Codat/Lending/Models/Requests/GetCommercePaymentMethodResponse.cs: id: 30a6633d4cf6 - last_write_checksum: sha1:1ad886fc46954fc3fa4dbe6c5c11b203105d5c8b - pristine_git_object: 76757e40eba3cd2da70ecd956790fa36b919fc15 + last_write_checksum: sha1:407485d6d3f1e760359ec4349938704037855a74 + pristine_git_object: ff7769843745575c106d07902afb683f0649a386 Codat/Lending/Models/Requests/GetCommercePaymentRequest.cs: id: b4db81802ec2 - last_write_checksum: sha1:c6435565f184fef320a4a9835dbf77dd965756e2 - pristine_git_object: 02e99d420aa957968851eeae8d4267e0b740e6e0 + last_write_checksum: sha1:c3c9c6b708aab3256269729d5f8aaeb5ab3b46da + pristine_git_object: ed38370f4f171dbb5dd280022fd2736266e42286 Codat/Lending/Models/Requests/GetCommercePaymentResponse.cs: id: bc3e85b5a6f7 - last_write_checksum: sha1:9840c70a948d9f725fd7677c39a7067201205667 - pristine_git_object: 14c2dcc014f8d67de40b3baf44a6c6129e8adf5e + last_write_checksum: sha1:b4b9ea69aa37e87eca4658298393160f814743b8 + pristine_git_object: f6bde4081c78aa9005e4b9acc11b1e1e5a91c0da Codat/Lending/Models/Requests/GetCommerceProductCategoryRequest.cs: id: "107512535972" - last_write_checksum: sha1:c40e5368c74eb57b02d9165e3867a9f03922d82c - pristine_git_object: 3020bf72741b29813e3b4b9aed2e676170d7df86 + last_write_checksum: sha1:c4bebd1ac3c17f99b2620cb4c5429262290b3a5a + pristine_git_object: d9584dfdb1bb21c1534c09d13c696480cb9ab8bf Codat/Lending/Models/Requests/GetCommerceProductCategoryResponse.cs: id: "9269474948e6" - last_write_checksum: sha1:3518770ab291f6e4b370f86d3fa39fb1665139df - pristine_git_object: 446d6d69e99bdb398c54bd80bd169a573d798390 + last_write_checksum: sha1:96daae31e157a6bed520b9716765159ada46064f + pristine_git_object: 1f48b6e1eeb3040da35c84663f77f6f7d0f94aa8 Codat/Lending/Models/Requests/GetCommerceProductRequest.cs: id: 24ba1bf2af5e - last_write_checksum: sha1:552abb4c82d054f2faabbd67aa4549b1d15e8a0a - pristine_git_object: 9cd6da223983a2476d26f82ce9f34d50044776d3 + last_write_checksum: sha1:4e58d55e99cbf8524b206cab9044b7014272456a + pristine_git_object: b8b2c3c8902f25e84a53815eb10ee090f9bfef60 Codat/Lending/Models/Requests/GetCommerceProductResponse.cs: id: 0b637ad37b0c - last_write_checksum: sha1:7e24e9c3cd564d9eb6171e6fd7172c7578016f47 - pristine_git_object: ca60d73fd4ebf67b4643745ac5df8221911b35b2 + last_write_checksum: sha1:66721434231ba10848a83cbba8b652ad476d4c06 + pristine_git_object: c31b9ac703c7e3530d6cd67ee159552dc8d4a550 Codat/Lending/Models/Requests/GetCommerceProfileRequest.cs: id: 905de874d9af - last_write_checksum: sha1:292e3b4317e3ecd0e410e7e9b11455c7539bfdf4 - pristine_git_object: aeb128f46265ea52473edb96dbfea28551f7e6f4 + last_write_checksum: sha1:6253889d8a0f7b30040c22b0bb50329b671c862d + pristine_git_object: 4f73fc9d9b3e1bcae8e649b4bcdcc6d0c1d16b2c Codat/Lending/Models/Requests/GetCommerceProfileResponse.cs: id: 5ed925978293 - last_write_checksum: sha1:64ac2cdc3b930a7300765ec62aea0693430f70ca - pristine_git_object: 80bae976e3994f35c5c3205cbb098a60a6ec340a + last_write_checksum: sha1:0cfdcec3725141020d687e5d16af3b212b49e837 + pristine_git_object: 75b86eec0aebb4c9d1a11640f4774c75dc5cc580 Codat/Lending/Models/Requests/GetCommerceRefundsReportRequest.cs: id: 66f79078cb4f - last_write_checksum: sha1:f5b3a5e0e934bc3c6c9a053202950ce6515ad26e - pristine_git_object: 46edd30886ddd4175b1c559536a98251b6452d92 + last_write_checksum: sha1:5719cef8436dfa7799368430ac328deb2bebe1ea + pristine_git_object: 351a5cf3f582201fe92c08ee679574e8268c0b42 Codat/Lending/Models/Requests/GetCommerceRefundsReportResponse.cs: id: ba54e5b346f2 - last_write_checksum: sha1:5764746a9f8532b4ae8696cd476fdb08b173af81 - pristine_git_object: 9ad5f6958dc8bb17d9099f6284df8ac914a36cbd + last_write_checksum: sha1:4f77dad908f5db67b707617dc2b6062759f96b66 + pristine_git_object: 02ced4dd2c23204d6099520c350d66139deb8161 Codat/Lending/Models/Requests/GetCommerceRevenueMetricsRequest.cs: id: 4164ef74af74 - last_write_checksum: sha1:1e6779c101ed248199eca54cc100db10a6f2634b - pristine_git_object: c5bb9c78aef2c7202a07855346d59a80843fe1fa + last_write_checksum: sha1:3448917ff0b492a17d5a9ae6e233b2e5d6fd2218 + pristine_git_object: fe0c690ae337aa6014aeb19a31c0e634ac420a51 Codat/Lending/Models/Requests/GetCommerceRevenueMetricsResponse.cs: id: ebf3a8ecd779 - last_write_checksum: sha1:6ed1979a9dc03caa64960e6651b0a99c1bd4abd9 - pristine_git_object: e6dd1a6d29b5c96c054201e65748f63419158628 + last_write_checksum: sha1:c08afd518704bf963e52aa054b752edadc614b47 + pristine_git_object: e8174e193749f445b960aa6212b6ae6372b2f718 Codat/Lending/Models/Requests/GetCommerceTransactionRequest.cs: id: 851ccc3fa0ba - last_write_checksum: sha1:32b9f0cbb5b4dd51763f8e9bfc8c7ed20f664f25 - pristine_git_object: 8e92a153fe2a02c4e840b94683c2bbc0bf9a6cda + last_write_checksum: sha1:e5a92093f1a80517d292c90fac3a9f3477c5a0f0 + pristine_git_object: d8c927705efe04c28109de50adecebf7aabeb843 Codat/Lending/Models/Requests/GetCommerceTransactionResponse.cs: id: 5585b33cd8f7 - last_write_checksum: sha1:ff27ceb4ce6b2c18d6bb65efb56074af8967a1f2 - pristine_git_object: 22dd01684c7bd6b86fd81759689fea131e2ee738 + last_write_checksum: sha1:1d683aa9d837e86f6fe363ccf036cc8795d9754a + pristine_git_object: 9e020a079c9ec4546f701eaec5942dce0e4a92ad Codat/Lending/Models/Requests/GetCompanyRequest.cs: id: 6209d80248af - last_write_checksum: sha1:1abddba6d5f16ff1a0ae766840441f8e745b53d2 - pristine_git_object: 82d14672298f6184ee674ddca745974835801d2c + last_write_checksum: sha1:e0af807ced025d78dc31143ba3d04b450b6ca5d8 + pristine_git_object: 3715070e41e080c8e623f3806e2daaf575d246a4 Codat/Lending/Models/Requests/GetCompanyResponse.cs: id: 20a2848ef309 - last_write_checksum: sha1:2427da5cf00f81a87b6954a0fd8c9cbf6c4d2d4f - pristine_git_object: a8a47b4802a757e0ea4bc4d04360a4a7ff2399d4 + last_write_checksum: sha1:88932392b7307e922ed046d29431eb0328d30b5a + pristine_git_object: 9a2367b3dc8ef75fe814e9d3227ece1bb3ab051b Codat/Lending/Models/Requests/GetConnectionRequest.cs: id: 6987221bae7e - last_write_checksum: sha1:9e454727c5c0b7946dd520aff25a68f56fa5124a - pristine_git_object: 81c443874896019e39d7d29a7d8f8320c4246a6d + last_write_checksum: sha1:6f7451623e71f94e51bd33ad1506868b7bfe3713 + pristine_git_object: 69aaa7349cf4cc9d07d342123ad0e221c8d972ea Codat/Lending/Models/Requests/GetConnectionResponse.cs: id: 6e118db8f0f7 - last_write_checksum: sha1:1269663d021c64016c40d36ac941c6030771f7bc - pristine_git_object: 13f30f90b4f67a8ab0cb3885bcf9d846220b495b + last_write_checksum: sha1:d14e6f299efc7e878755d82de4eaf1be10b02ad8 + pristine_git_object: d5861b3c8bebd4bfc721e17c8fbee1e95541ede8 Codat/Lending/Models/Requests/GetCreateBankTransactionsModelRequest.cs: id: 490084490d39 - last_write_checksum: sha1:611438be0d599cbaa92897b5b7804bb30d5a17cc - pristine_git_object: 3e9eed827aee3bba7f2b1054034608d69e252be9 + last_write_checksum: sha1:7ea959b2175609e31a27737a35bdbf4d3d2137ed + pristine_git_object: 17795c33101f2c8fc304636132c973b4e87be07f Codat/Lending/Models/Requests/GetCreateBankTransactionsModelResponse.cs: id: 4c115f003806 - last_write_checksum: sha1:8c69ac7b1a92191574572b25312600ddfae18792 - pristine_git_object: 707833476984394fdc0982eb0687180e97fa83c3 + last_write_checksum: sha1:063ed1c97e25a9b9383f7336d13ff2305d4472aa + pristine_git_object: a96e2c1032869dee1b9a5760b7e12526d6bc5184 Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelRequest.cs: id: cf7bc6af5974 - last_write_checksum: sha1:3e1995db691d0dc9a41876433c082b888337378b - pristine_git_object: 06df207dca5c66ecfecc4fe14db9a420f4a82aeb + last_write_checksum: sha1:9046238bb328875cf44790a05440598b614830f1 + pristine_git_object: c3ea5e906e4a42356e5803b2ae57d12ad4b4ffda Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelResponse.cs: id: 438fe9d09ffd - last_write_checksum: sha1:41e3b6da5c10f459997fd1f81f2d244be2e25ea2 - pristine_git_object: 5a6255703b665a693b94a2582e1ff3a2ead2b51e + last_write_checksum: sha1:953f589283083eb46f752392648ff1c859f858b1 + pristine_git_object: 3affd177bea39b0b58ac0493af31a712979b1a79 Codat/Lending/Models/Requests/GetCreateDirectCostsModelRequest.cs: id: 30cb9887dc95 - last_write_checksum: sha1:2b76aea53e20c5c616966903e7f915d4ae8f195a - pristine_git_object: 9022a01721ed0f0053e32932a788369b7a2485aa + last_write_checksum: sha1:3d7133e4c021b2137650d22d5bfd27e51892a6f3 + pristine_git_object: 3b727b1fd4dc6bc2f6ebf1fbc8b9d2da098d7cb5 Codat/Lending/Models/Requests/GetCreateDirectCostsModelResponse.cs: id: e45930405e00 - last_write_checksum: sha1:7dc18952eb73824df8b7f6e48f4b3c73f25d123c - pristine_git_object: 63d850ee65a7ec7333503cd51f4a9899306252fe + last_write_checksum: sha1:4984c0b245f5f4a979827d3032e207e1d1d5717e + pristine_git_object: cecf0582ed92ebc7751836fe6f10e132f48256fb Codat/Lending/Models/Requests/GetCreateOperationRequest.cs: id: 691bdddbdaad - last_write_checksum: sha1:e9d5d207ea73abae55a744a96635c62e262d698d - pristine_git_object: cecd2b2d1101d6740311f87e79838ea1f4bbf6fe + last_write_checksum: sha1:1280eb8797c08f14b8b932a22f332990b0362a1f + pristine_git_object: ed5626ec672f7f6911f7442b849dc403b3d953db Codat/Lending/Models/Requests/GetCreateOperationResponse.cs: id: e17cf8459ffb - last_write_checksum: sha1:d3034164bef0df012b47986d0b4abad8710313f5 - pristine_git_object: c697b56db379ee43e5a06cb297097c88c73b28a0 + last_write_checksum: sha1:3162c641ace2ff6d02670285ba197b56e6b91f66 + pristine_git_object: 58c824b2f90a4e67e170c1d9d0f6b03312798da7 Codat/Lending/Models/Requests/GetCreatePaymentModelRequest.cs: id: 297214c6a0dc - last_write_checksum: sha1:15fb4cc8823d18ea8ebdb5d75ca8580c736ae48e - pristine_git_object: e7f8a85dd4cc4a0c39166d13f54a06f2629cce55 + last_write_checksum: sha1:dc22def9d49aaac724efbc714f7b14872f14332d + pristine_git_object: 70d588dbebbbb14281417f60a48c3e81b3b58c9d Codat/Lending/Models/Requests/GetCreatePaymentModelResponse.cs: id: 6b94254a4fd8 - last_write_checksum: sha1:6a8ec85f6407845086f0a5d9a0862f62dfed54cf - pristine_git_object: e9a84d8a841a847f8c67a471db447f10d7095af1 + last_write_checksum: sha1:022dcc6ae6fb0a21c8b3334a655ea69e260898bc + pristine_git_object: 93844b957479cf221250e0ce0868bbc140a45a37 Codat/Lending/Models/Requests/GetCreateTransfersModelRequest.cs: id: e7e46565687a - last_write_checksum: sha1:0fc757b3eb69f13d61d00cbdfe9b1ebbf9236bb5 - pristine_git_object: a6597a109c1d2047e6bf856f9eee90249cb8e673 + last_write_checksum: sha1:33a1a50c8f5b39e0295432455771f8a3e6953396 + pristine_git_object: 0731d06758ae28162af7a40e94521398ccc1edbd Codat/Lending/Models/Requests/GetCreateTransfersModelResponse.cs: id: 559b2dd8bfdf - last_write_checksum: sha1:d15b1d53e890af544f852931cfa6a8b49a45f634 - pristine_git_object: 11cfcf11918f6a0d47487f4eb17b022c60751984 + last_write_checksum: sha1:876ae6c8b4a28f9bc46492ebf165d3776903114a + pristine_git_object: 05931339931a63088edc2ab2d6f65c57899c747a Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelRequest.cs: id: 71a684e8d36d - last_write_checksum: sha1:411179286242051097fc06ec45a259d6e2c010a4 - pristine_git_object: 4a0221951c312ef32f899935738cf4b25b8c178a + last_write_checksum: sha1:c3c3779007cd623656efd06a32d2bb8ce517a613 + pristine_git_object: 6fc614e7d7f7a9f4a5c19f1d765037ee114ee093 Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelResponse.cs: id: d21a219a5c26 - last_write_checksum: sha1:79ca8f71e8f7750aad2eacfc0b0745ab76b36455 - pristine_git_object: 0b4ab65b88bcaac6e80c3324cd66ba2c89aadd8a + last_write_checksum: sha1:caa3738d2a93514b0e8285952f013a84e6885cf3 + pristine_git_object: a26913692133ee89e56b03eca988f8f7c53dcded Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelRequest.cs: id: 1205d610813b - last_write_checksum: sha1:9d2cf458495897ec6bce5eb3e07407332e436e1c - pristine_git_object: cd95cb2da814693ff1a23c481160d6f52a15bf6a + last_write_checksum: sha1:eafcef61d940b58e3e9699203a01729a4513d31b + pristine_git_object: ce2e8206c0b5a0ca8aa406c586e04e56dc0acb0c Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelResponse.cs: id: 6da32d411d28 - last_write_checksum: sha1:68954f9b0be7a8260908c3a5595febe6440475d8 - pristine_git_object: 77ef7e574e29dc12a6e29494c3df0954b220ec4a + last_write_checksum: sha1:49af55efc13d926509e15c5dc7772c8702bd2ae9 + pristine_git_object: f80bf8c4e095d8fc45580220f22856cd04f7cf57 Codat/Lending/Models/Requests/GetDataIntegrityStatusRequest.cs: id: c4f095042f20 - last_write_checksum: sha1:04a60ac5fd352b35096bf4c3c9aceb0d79d5b022 - pristine_git_object: 6daccad1d33ee18ccbe8c038af01b6ae68290e5b + last_write_checksum: sha1:8ece6709a1d16665022c1e6667b4c77e89cb2ca6 + pristine_git_object: 161aeac6c59fcf10cdd979e19e4c5ed3d7b6ba1c Codat/Lending/Models/Requests/GetDataIntegrityStatusResponse.cs: id: 593eacd205e4 - last_write_checksum: sha1:2e89844def546461a9f7f828e9805f82fa4fa91c - pristine_git_object: 650c9f71771e7b1feee65ebe27891428b244552f + last_write_checksum: sha1:83dbf69afa73390dcc6619d668c97e2a80946926 + pristine_git_object: fff12c6cb1e3387180ddca51cb1a7f010eee7521 Codat/Lending/Models/Requests/GetDataIntegritySummariesRequest.cs: id: a86aefe9203e - last_write_checksum: sha1:d4d431a038c4e06b25babba6913205290aea175f - pristine_git_object: e9f4da946aa52063eadcb7850c69d7b9177e2b33 + last_write_checksum: sha1:b6dd92b91c05f2e8b39edb698056c11314bbaa3a + pristine_git_object: 8dbbbacaf2d9fee73da48f3a4935403925b6de1d Codat/Lending/Models/Requests/GetDataIntegritySummariesResponse.cs: id: "3410816437e6" - last_write_checksum: sha1:873f4a218d38ba71ad6b85f1d2c9792679beb6ad - pristine_git_object: 903fc094df33983d4a5f362174eb46b2ef8c0d22 + last_write_checksum: sha1:9b6bdb9536c4fe515291fe00019193deeea38f74 + pristine_git_object: 35e0f882d882bdf89e5834f80710c5e44d04532d Codat/Lending/Models/Requests/GetDataStatusDataStatuses.cs: id: b11a0ba24226 - last_write_checksum: sha1:a11a233ef141a7f7c4583ebaebc254c14f28aaeb - pristine_git_object: 5d8a2af3e5e91abd0e1e3298b280dd2caf9f231d + last_write_checksum: sha1:cd91d60d418efad89daf72da0949f09abe3d7b73 + pristine_git_object: 0918ef6a903244e0b12b7d161c1be3860aa81f46 Codat/Lending/Models/Requests/GetDataStatusRequest.cs: id: 62af2115a8b2 - last_write_checksum: sha1:74347be4f4f82e98d758ee2209bbf01d4ceda64e - pristine_git_object: 7fcc8cb1c0ed6e2898135a66069ba63470260e4d + last_write_checksum: sha1:84f197974d9cb33efd46d4cdd28a0cdca25ea538 + pristine_git_object: f3db4f313d8bb2c4b7356dc784b18b6e16ee92f7 Codat/Lending/Models/Requests/GetDataStatusResponse.cs: id: bae270721f80 - last_write_checksum: sha1:fc7c0fe2a1044a8c79d57e96da560b7effe6ad8e - pristine_git_object: 9832e06cda80ec05abb5d2efb4903a55f6911a10 + last_write_checksum: sha1:3859ca36d3cb5485a9ab8f9bf2557f5529781d02 + pristine_git_object: 1e00a48aec3497c1428f0f10c5134979db2bdae2 Codat/Lending/Models/Requests/GetExcelReportGenerationStatusRequest.cs: id: 500a3fc9d012 - last_write_checksum: sha1:7492dd3d43787894a0e1409f525b1ef2dd9d9499 - pristine_git_object: 8da0fbfcafbde8568530c7c16252e9dfd5661842 + last_write_checksum: sha1:06c391336e973c31bca10bab1711b7e5b52a01d2 + pristine_git_object: a26de164ef6ec703ae8ed024d67acd9342d878b8 Codat/Lending/Models/Requests/GetExcelReportGenerationStatusResponse.cs: id: dca63cfd2a4c - last_write_checksum: sha1:ba89a8985ff7722246e24c43cc6263d525d4b224 - pristine_git_object: 4584309cabd6dd3e574a6df4556f2f7ae2403d5e + last_write_checksum: sha1:06c391e77b940cac161e7e6ce75f2c87ed64cfbb + pristine_git_object: d9c4f74c621eb7955b58fc51efecec5945db99da Codat/Lending/Models/Requests/GetLoanSummaryQueryParamSourceType.cs: id: ffd73fea0095 - last_write_checksum: sha1:c73919bf927edc7d9992f47c813eeffb4240dc3c - pristine_git_object: a5d2dbd7c4f433d9ec7dd6a8bd4b15aab2599d70 + last_write_checksum: sha1:f65b9179d23a656826d9ab6106307c67f694005a + pristine_git_object: 5dd3ee6fc11b32488b9c7b6c9277b84d7fadf9e2 Codat/Lending/Models/Requests/GetLoanSummaryRequest.cs: id: 0774c2c14b0f - last_write_checksum: sha1:ea97cabc50d0c5bfad0cc5cd6228965aa06a32e0 - pristine_git_object: 7e7f00e2e28d3563f969e7ce5538f072cda762c8 + last_write_checksum: sha1:6f4e0b3a7558fe95d49fb83c8296382478307ac6 + pristine_git_object: 9c075a248afb7c42c4b28a9837bf0226b63fefff Codat/Lending/Models/Requests/GetLoanSummaryResponse.cs: id: f744aff1a6b8 - last_write_checksum: sha1:e68ea027748d3ee3d6cc2929c37441b8b03e8164 - pristine_git_object: 1d24ffc47091f019cf48664f03c6d62d681297b4 + last_write_checksum: sha1:6f8e9a36de7a73f05ca5d29abd8b1facc4478415 + pristine_git_object: 2d24ff150cbf1fd2ba76a2f9e36e28dec5a0d210 Codat/Lending/Models/Requests/GetPullOperationRequest.cs: id: b640c229a111 - last_write_checksum: sha1:31b97ad90207e3a00cc8602336040ae0128b4aa0 - pristine_git_object: bb45323df57ae82f14b1feea580378c48cee32a4 + last_write_checksum: sha1:0e1bb0af0e5f10c9ab5be9f26e61ce3e12308b1c + pristine_git_object: 7f3c675a4e6aa6e31e559a4d7107c22c750c4e87 Codat/Lending/Models/Requests/GetPullOperationResponse.cs: id: dc5bcdc281fb - last_write_checksum: sha1:69f07d1386675c963efe4346b7171eb22a312002 - pristine_git_object: 9f46e4e33b2933931c0852702b70898ec6bc5e6f + last_write_checksum: sha1:70babc17e81400d16921a523b66cab0d0b598c34 + pristine_git_object: 0f42b0e549bc53e003ec54dee995ec2e76511d65 Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableRequest.cs: id: 31a9c834234a - last_write_checksum: sha1:6d749e7f61231b42b433aa0b78e08fe02a65c9ff - pristine_git_object: de4dcc41ae47174513f41e7266603449501f722b + last_write_checksum: sha1:53642e7caf0f670d0bcacbacd13fad022e4de5fc + pristine_git_object: 4a8982cc9b334db47c7893b257a3d9a6dff7d8d7 Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableResponse.cs: id: 2aaba2caf5e2 - last_write_checksum: sha1:b78b9c12cd7308bc49ba686a0ddadd023693ff04 - pristine_git_object: 83e458d563cfcd68adab55175ad53fa6abc91220 + last_write_checksum: sha1:b4125dff0867c140c6a00d86e8f259a2d98d1a65 + pristine_git_object: d50e2e4599b8653e8c47a09c9ab0f113f585a1f8 Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableRequest.cs: id: e75c98c497dd - last_write_checksum: sha1:07d10ca5b1e2e49b647ee31fcd3ee5797f3e335c - pristine_git_object: 224533f6501a43b6d0bb83bc41c55927e9ace09b + last_write_checksum: sha1:0e51735dcbc896a37d29e5c2a7d7ae6b902073f2 + pristine_git_object: f4851426744f71984aa7452267f8ac8d73a7cab3 Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableResponse.cs: id: 8c2325dbd760 - last_write_checksum: sha1:c89aa2147483dd367c90c34df1da184a4708a088 - pristine_git_object: 832e2c66ddc072d03a815ea61ff3789b07026e8f + last_write_checksum: sha1:83cf89f6c7bfe5e9ea6c3881e4c0e69945c14353 + pristine_git_object: fb3d0b482386ec076b96ea61be4b55764b5fd8bb Codat/Lending/Models/Requests/ListAccountingAccountTransactionsRequest.cs: id: 13c323d9bab3 - last_write_checksum: sha1:14939e5f50436ab77d0d48051458dea9dca60cff - pristine_git_object: 16ee40cd42e173193a4b25333bce845c3b964b1a + last_write_checksum: sha1:ab4198ded57b1211d388ffcc66c8da8d8bf1ba91 + pristine_git_object: 2f9174125857a76637bf150fe101a0c3f1f62bf5 Codat/Lending/Models/Requests/ListAccountingAccountTransactionsResponse.cs: id: d644363fed8a - last_write_checksum: sha1:993e78030cd2ccee3323554fed5bd901c6b8a8a8 - pristine_git_object: 820d04f87d152b92d7ab6db5271e1bf1b0ca78c8 + last_write_checksum: sha1:f3934ef9cd2c2e32c77703c5d5e16019aa1a0939 + pristine_git_object: 052a927cab2737da5c177ba60ff0be1b34e37091 Codat/Lending/Models/Requests/ListAccountingAccountsRequest.cs: id: d00edb00851b - last_write_checksum: sha1:d9e57ea580513ab67e18f6f1d691414538edccce - pristine_git_object: 7079908160919944bbf8c6a22d33788b51421902 + last_write_checksum: sha1:b1b773caabf8622622dddce298ec63dcbb1bd122 + pristine_git_object: 8b41957893b93bd8805b409cb0a802a55228f45f Codat/Lending/Models/Requests/ListAccountingAccountsResponse.cs: id: c5e462ad614a - last_write_checksum: sha1:df76365b5d2b8bffe6031965b401432b564bd0b8 - pristine_git_object: 9448f23c9295a7b9f2d7a8e41a20e1b9ce99a48e + last_write_checksum: sha1:864d9ba28c2661d5266daee68ede2b851e01664f + pristine_git_object: 4eab5d69f4be269bcb1c15bc91adc073ceae0642 Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsRequest.cs: id: 6391de1499e9 - last_write_checksum: sha1:ff3d8baf9ee4526323afaf009e806d81e3035a1c - pristine_git_object: 2398446b803b69802bfa9062548bf144487da025 + last_write_checksum: sha1:3462e587a88abe5b23ff11027b5c3f903c6c1dac + pristine_git_object: 18e50243c83a614659c11e540dc809bc97527442 Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsResponse.cs: id: 79b5cd541f6e - last_write_checksum: sha1:a138810469dd480242fce3a74fcfe8aa2d6c76e1 - pristine_git_object: df856fdbaddd251a885bf04e879bf4a87b980b0e + last_write_checksum: sha1:06f6cbb5ae8668ecbe67f98523626d616f346434 + pristine_git_object: 51b726a1fd5f98c6b866d8ec59aa9c9cf67fc235 Codat/Lending/Models/Requests/ListAccountingBankAccountsRequest.cs: id: 46e04c91900d - last_write_checksum: sha1:ce41dc82d6ca7bf14c69d5c8ee056be9922ecdfa - pristine_git_object: b6fe82c9564846d7e9d20079baafe9ca2da6f02c + last_write_checksum: sha1:3de0384e81b6a7a999ef103f8e655c9279fbfc93 + pristine_git_object: e1e30b6e120e3ce83b8a75a8d8874bbf84645647 Codat/Lending/Models/Requests/ListAccountingBankAccountsResponse.cs: id: bde176efd0af - last_write_checksum: sha1:dcc1fa9194bd8a032513ea943203c6df15f89346 - pristine_git_object: 02ba0519c43db7dc4b78fad4fd27014427ac1014 + last_write_checksum: sha1:51a1fe827cfedd137f54f6d9364669db52f3df99 + pristine_git_object: a27c83be2544304a6a363700f0b959da00691882 Codat/Lending/Models/Requests/ListAccountingBillAttachmentsRequest.cs: id: d1d5a11de9dd - last_write_checksum: sha1:4314abab8e58459cdfd3446b7067cc41c8e30249 - pristine_git_object: e2cde18827e136517dc26414f0f6bf3418d5e533 + last_write_checksum: sha1:32cd2bd4a32c5f2ca7e71eef747d8e05b1a26a58 + pristine_git_object: 7f4256429dd2c30ffba6bc18803e4164c52d7b25 Codat/Lending/Models/Requests/ListAccountingBillAttachmentsResponse.cs: id: 4f0ed0119056 - last_write_checksum: sha1:bc04bea7376edfc4bf6bcbb480aebe000870e164 - pristine_git_object: 123ffc3314db14c653df4c812ecb5e267c46d1fb + last_write_checksum: sha1:7bf36aa80b777da5953747b6125820cb89070ddd + pristine_git_object: 4617fbce35caafd936b1a54534d5b824428ebbdc Codat/Lending/Models/Requests/ListAccountingBillCreditNotesRequest.cs: id: 42f5d7b80284 - last_write_checksum: sha1:7f9ca7fc2f1bb29040c343a9cb1b74845bbaa9f3 - pristine_git_object: 7635bf13bc860d7f374c987cca147b0c06cc185e + last_write_checksum: sha1:b7da3a03ac5cabf6709594354c5da30edb51165e + pristine_git_object: e8107c4a635c0ffbd2c7ce64a0401a8f6c9d26bd Codat/Lending/Models/Requests/ListAccountingBillCreditNotesResponse.cs: id: e28a0b9bf390 - last_write_checksum: sha1:19f0d4f8aa0c14da5bb5ca6b0d167b20f9ca11fc - pristine_git_object: c9a38f4737df813006f44441ae9f74b409599bee + last_write_checksum: sha1:2627e7d3e6a65fccb49b75d3190ad3e0e1722654 + pristine_git_object: 281ee47ec34dc62596457a424a64eb3933e3e898 Codat/Lending/Models/Requests/ListAccountingBillPaymentsRequest.cs: id: e3d4c49f622d - last_write_checksum: sha1:a4eef99b14f0d34dd01d7389bb78a32a67074fb2 - pristine_git_object: 5ee232b7548a71263969e2e2a294f96379b2ff6b + last_write_checksum: sha1:03057ee60b5e577ed8c355d0eaa84f1a9d496c20 + pristine_git_object: 3fae78f404be8d08c3e49444d344fe96642f8256 Codat/Lending/Models/Requests/ListAccountingBillPaymentsResponse.cs: id: 1976bb6834f1 - last_write_checksum: sha1:1d7d29ed946885b3e056a2d28bbe900dd25e8412 - pristine_git_object: 3a14f64ca5ddd9e1d1761f45ae41e261a5b0673f + last_write_checksum: sha1:a2d5623c66e391f16676993dc5702f2d8845afe8 + pristine_git_object: 2753d40772524e2e79d87a38497dc1f535c23fc0 Codat/Lending/Models/Requests/ListAccountingBillsRequest.cs: id: 632284b345ff - last_write_checksum: sha1:3f423bcb1dee3e090a0f2adfcd028f95fddf3dcd - pristine_git_object: 22a3032635b16cd279c44e73492be99054d42d5f + last_write_checksum: sha1:d86124a73039f4a21da0c90462c1d9e595dc1ce7 + pristine_git_object: 3276e589f7bded00422aca72cc1700884b3ae179 Codat/Lending/Models/Requests/ListAccountingBillsResponse.cs: id: 063bbb48a233 - last_write_checksum: sha1:23de787f2b91a7f2fa8af2f8917ffb36033865f4 - pristine_git_object: d8ddad42ccfef731b1d50057c6da2ca2d6ddec97 + last_write_checksum: sha1:f5cf4e56ff4b5ddf2af41e722a8b0318b68e85d8 + pristine_git_object: 21ecae63df024e7395a602e6e8997c7ca74bbf34 Codat/Lending/Models/Requests/ListAccountingCreditNotesRequest.cs: id: b6061b3beb2e - last_write_checksum: sha1:21eaa73a9372bdbec77dcff70a3c5023273c1b29 - pristine_git_object: 2e6fc0d3b3ea529337e48c65fac2972813aa09c5 + last_write_checksum: sha1:513cf6bb0738adac8c15f9a1abdda11f5839c589 + pristine_git_object: b104a334ad709ea8919dfb5fb0f7c29143fc24a4 Codat/Lending/Models/Requests/ListAccountingCreditNotesResponse.cs: id: ad5c6d0e8c0f - last_write_checksum: sha1:9b624482085e519b836abc09293b652ea10fee75 - pristine_git_object: c45b66053b1b6d3ecdf6d874918256e64e75daeb + last_write_checksum: sha1:f3b7655a5f4e282660886f127875c199e2f06eeb + pristine_git_object: 4b1f89c3053b268c4b878091fbd9f97233439303 Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsRequest.cs: id: c15d06f1eca6 - last_write_checksum: sha1:94ef40943a5c88144b8a49788dbada724fd637a6 - pristine_git_object: dae2eab6d862536d56de49f1e7874a63b71ef0af + last_write_checksum: sha1:92cf3a159f3af46f7652ba70dc6b536e86414535 + pristine_git_object: c88101cad00b85e9ae1c8c47265b6c3b83ffe804 Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsResponse.cs: id: 6ed95d6f2c9a - last_write_checksum: sha1:8d8231dcddc257e4429614d405ff6e663be9d1e4 - pristine_git_object: f2a8633f786979ce2682fe6ae2ff87c2c6e5b634 + last_write_checksum: sha1:9784659567efbc7c33fccd166d2b5c1dfa5a073e + pristine_git_object: 6e79b0b3c3da164a105fb68da1f99d864efa6d2b Codat/Lending/Models/Requests/ListAccountingCustomersRequest.cs: id: 42061fe6c48f - last_write_checksum: sha1:f8757c0c90871fb1111fecf76cfe47ae62744d27 - pristine_git_object: a6e98a783c4e58e99a0afca4aee7abd771cb7f4b + last_write_checksum: sha1:8ce8fb31c3c0059eda1e480295e01b4a83ab1b52 + pristine_git_object: 5705268b2daf4795e275240ebd109db6873879e7 Codat/Lending/Models/Requests/ListAccountingCustomersResponse.cs: id: 60d003e6038a - last_write_checksum: sha1:31be29104e4245243caadd608b7b125e8b0b89d0 - pristine_git_object: d129c2aeced188a7ecd03b4aa07493d39233a839 + last_write_checksum: sha1:9690c5f330d83dfdd4cfe8e6757fe5fb5854894b + pristine_git_object: 26b8526bda099c3d6386889b47930f08956120b9 Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsRequest.cs: id: 76b772ee1807 - last_write_checksum: sha1:b64375c18ab1ed259c7bc1fcb9b13a2c82183184 - pristine_git_object: 042b7c0e0104fc5a55a91930bbc246430b38bd54 + last_write_checksum: sha1:5f734d8fe6cb075e2c3211b6d24b9995200ded01 + pristine_git_object: 0c01e27a9b34a764f330d9b9656e5a51803aa470 Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsResponse.cs: id: e942ba3af1c9 - last_write_checksum: sha1:0bfa568509b63e101dfdc08673113b963cedb497 - pristine_git_object: f62942f97afb30dc6c705c1593590eaf3e7382b3 + last_write_checksum: sha1:d86767f22d208c29845f6095a5b22dc4f495d6cd + pristine_git_object: 46a21b1b0d6ba711f82910743dfe6117aa411108 Codat/Lending/Models/Requests/ListAccountingDirectCostsRequest.cs: id: b0cf252514fd - last_write_checksum: sha1:2f282332a7733e60f6a9c164ac7e13c31902e4a9 - pristine_git_object: b1182b55a02683d22bd9a2c1e21fb3b5ef3e983f + last_write_checksum: sha1:a981ca6762827c5e3838343b947cba28357f5a04 + pristine_git_object: 14ba0386ea522c452a3f757b6009ddcf4d36d0ac Codat/Lending/Models/Requests/ListAccountingDirectCostsResponse.cs: id: 5173c319c873 - last_write_checksum: sha1:dba2780a7301db277286cc30b147323d6928cf57 - pristine_git_object: c3b5eede72fbe70e80e2a0bde7d6a2bea08a968e + last_write_checksum: sha1:75c6a8602cada5982e4a918f6121bffd56b94b6b + pristine_git_object: c70dd00fb96e45d02f2008d6865fd0373ff3227f Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.cs: id: 6d49f3be5534 - last_write_checksum: sha1:4c1b4e1312593258d5e21f5cd28e7b20942cd29e - pristine_git_object: 782d12f38af984de5732e83c72952089f2b9b0ea + last_write_checksum: sha1:c3d44d43f60216f164bbb32c1670af0ff5867209 + pristine_git_object: 0759d718d420a313c52bc2257a98596fed27e35c Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsResponse.cs: id: 1b12fb45547e - last_write_checksum: sha1:72ca0cac807a5dffcb9f5b94e0e142790da448f1 - pristine_git_object: 4069a0a2a35cad79550edb7d3fae6a632fdbdd4a + last_write_checksum: sha1:de0209b9e5ba5b91270d30f84c1d9f65f64c8925 + pristine_git_object: 5e8656f2de30e84c609a3aa4145f90131a6c1c0a Codat/Lending/Models/Requests/ListAccountingDirectIncomesRequest.cs: id: 144e2bedd27f - last_write_checksum: sha1:74690193967109eb1f80fbf00288696a986038e3 - pristine_git_object: 1d42ff23085e5650d54b0a26b931ef01a602f10c + last_write_checksum: sha1:b3ee7a0b6f942589a6904645cb9bf1b68683e672 + pristine_git_object: 946a2267125554f81c53624a41675ad5b8f37bda Codat/Lending/Models/Requests/ListAccountingDirectIncomesResponse.cs: id: 131866f7705f - last_write_checksum: sha1:ad1f40d6c75e0201e989b1e7cf8202eeb1d2c6e8 - pristine_git_object: c5df263290f6dd1fe1e670ff43303c95117a1636 + last_write_checksum: sha1:4c2cd83d34b7684618f54b4edb33b520454fe566 + pristine_git_object: 5f3e985ac3a58dabc13ce8115314d9f0e185c851 Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsRequest.cs: id: 7685dc7af374 - last_write_checksum: sha1:30f401efdcde5ba506d1c8f7d7f03cff0a46db1e - pristine_git_object: cb2163ad7046efeb8a7181b56c1cdf74fba42c0e + last_write_checksum: sha1:ce0ea0d097580038e4209ac2a06873b53f5e131b + pristine_git_object: ce52c0d2cb0be2ca558e9e2c25f46b94a3725233 Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsResponse.cs: id: e331faa9c53d - last_write_checksum: sha1:79332d1dcf88804989d74847ddb3bc0c0ccbedf9 - pristine_git_object: cc932781d2042d613e309bda56251e0ac5f07dd4 + last_write_checksum: sha1:0e9d753c9a60e159bd7ca4acc0b243a71e614d50 + pristine_git_object: ae2aa10087b81771e577b696eb3d3d3c4f5cba5a Codat/Lending/Models/Requests/ListAccountingInvoicesRequest.cs: id: f3ff7ed1e101 - last_write_checksum: sha1:a7c802dafd323d3aca4b368f7b7fc7224384a956 - pristine_git_object: c2ccb6359f714abff56d91c5235ac86f48fc759f + last_write_checksum: sha1:9209ef2016bb96b3a8808501583e866a858bbd0a + pristine_git_object: ad53228b73a8ec7517aaebfb05962bacba3f6b97 Codat/Lending/Models/Requests/ListAccountingInvoicesResponse.cs: id: 015b3a7f1e4b - last_write_checksum: sha1:e5209e5058494371ddfdea381a75e8583fd99b7a - pristine_git_object: 5b4d6910ad3752fcd5665337a9d8594b73ab08dd + last_write_checksum: sha1:a984e6b64e051aadce777c8135bbb92ac56eb0ab + pristine_git_object: 10131f1a32bd9bf3be8272105fb1685f18daddb7 Codat/Lending/Models/Requests/ListAccountingJournalEntriesRequest.cs: id: 7869ef202705 - last_write_checksum: sha1:3dc03c80d44bc66c448b97f4b52d745f7a4a275f - pristine_git_object: d902760bf10a4ffbee9851239740b40df6bd3daf + last_write_checksum: sha1:f9a9b31444543457f2d14edc216be872e0bd035d + pristine_git_object: 535a9e129461303b8704b8e1e495a17d923924c3 Codat/Lending/Models/Requests/ListAccountingJournalEntriesResponse.cs: id: c4256d34ac68 - last_write_checksum: sha1:88683c1e437604a0eff2bd280fd448e315377d5d - pristine_git_object: 879e3b2185952c503e2faaa4903cf66172370c4c + last_write_checksum: sha1:b212193200aeba1c786a9bb107ae31f1829992a2 + pristine_git_object: fc1ca7b2b1e560885ca0a9e51d8246f2970699da Codat/Lending/Models/Requests/ListAccountingJournalsRequest.cs: id: 07bbe9e6ac09 - last_write_checksum: sha1:523e13dc75f360f706e3dfe8b4017efcdf57781e - pristine_git_object: 25632252056cafd50dbec9c1144ae37235e52ffa + last_write_checksum: sha1:85857cd3cc7996bcd01b5e1ffe8a66f3b0c5d07f + pristine_git_object: e95e6262e9d0c38cf078c11f276e353d70dfd197 Codat/Lending/Models/Requests/ListAccountingJournalsResponse.cs: id: eb98cc5a8b9b - last_write_checksum: sha1:1d071962969f3ac799cb947405c96d99a3383043 - pristine_git_object: 630f9a4e9e9db26303354bb05d15b64f02a34bf6 + last_write_checksum: sha1:69a7ab8df2f5ad705d1fd51c06a31cdd0812eb44 + pristine_git_object: 94eb7bbc5cc23a9190926404e0128ddb22c8919b Codat/Lending/Models/Requests/ListAccountingPaymentsRequest.cs: id: 4776f4a4f292 - last_write_checksum: sha1:b0ab5005df8640edad15e08018e6a131633a4218 - pristine_git_object: e137e5be73434016bd9faa5c434dfdaea99eab1d + last_write_checksum: sha1:299df06a346caf63eb1123095872c9f051e941d2 + pristine_git_object: 41f18f12c7a6288de9f491515773108348b018a6 Codat/Lending/Models/Requests/ListAccountingPaymentsResponse.cs: id: 432bd4a0c74d - last_write_checksum: sha1:146db0580870deabe055713d951563c4682b0478 - pristine_git_object: 30c7ad35fc64ac03b0547d15ab32c58f3f55c8b7 + last_write_checksum: sha1:016cd50ca9746a2648c2c0a5945ea6a142aa0c70 + pristine_git_object: efea81e913202f55ff97f5ec4fb1f21d37c2e5cf Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsRequest.cs: id: 09eeb0a152b7 - last_write_checksum: sha1:b15f739a01db348e7a7a6e707333b27913c845c2 - pristine_git_object: 2a8d287644e1734dd921262334183e8b333cea1f + last_write_checksum: sha1:ec469bde66ee96a4b6d5758e719dfe2cfa13093f + pristine_git_object: 309963c3a45a509c248893941b02b717ee736c7b Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsResponse.cs: id: a96356006c81 - last_write_checksum: sha1:604b7632ca60f028ed6de1e66b20c62099c0802d - pristine_git_object: 18a4c9a3cd77bbda19327295c6845f8f117ca569 + last_write_checksum: sha1:717b60679dc0f5ed288ef8a0a81cfae8616c8a55 + pristine_git_object: d5c139ee3343a49037bbb5835535d5cd91f6d1d9 Codat/Lending/Models/Requests/ListAccountingSuppliersRequest.cs: id: 40a744d183bb - last_write_checksum: sha1:a7b86464c535fb94417497fdc688aba8a9774e64 - pristine_git_object: 22713cb7de722db7d43af0eb4384ae725d910436 + last_write_checksum: sha1:7a1bf981a045572decbe9fa6cc1e01000955c34c + pristine_git_object: fe88ceb09d3bacdeaefd8eed7a403b1ff6513f1c Codat/Lending/Models/Requests/ListAccountingSuppliersResponse.cs: id: a9b168473487 - last_write_checksum: sha1:266c5c1c44e35be5c007b192be249fa90d2f1fa1 - pristine_git_object: 249a7adc1202a900142910fe9b0636554e9b1b4f + last_write_checksum: sha1:d95f62bafde261397f63071b84baebd40d3913d5 + pristine_git_object: 8ea47a6427ba8c2892acf6ad7b3321f0af265d80 Codat/Lending/Models/Requests/ListAccountingTransfersRequest.cs: id: c264d4b0cdb1 - last_write_checksum: sha1:fe3fde24fffe2837fa8ecef1c63118c0bd381c5f - pristine_git_object: 32b1cf1f37f61ddf132859d1c642122ad2f432d5 + last_write_checksum: sha1:fdff2787c1baf39775e297e8296c5d6e1b2e95ee + pristine_git_object: b822b091201963ffbd2db25580bab9615363c1ff Codat/Lending/Models/Requests/ListAccountingTransfersResponse.cs: id: 6739702d6317 - last_write_checksum: sha1:cfc6c053ebc4817f807de61cb26217c8419e918b - pristine_git_object: 41cf99505b574b200eefe3c568becee638923117 + last_write_checksum: sha1:30eefe455714b30c66c63596b6aa49592c9a2c64 + pristine_git_object: 53f6d04c9caaeffc98f069a5552ee2491a73f2fc Codat/Lending/Models/Requests/ListBankingAccountBalancesRequest.cs: id: a7ffc3a9f357 - last_write_checksum: sha1:203892506cb55214b3c0ea0b775c5cac4578b23e - pristine_git_object: 1e2b745d148aabe7d3787c9a6f94d7a34adfa462 + last_write_checksum: sha1:a2c919408bb5b6ad2b66f727102da8711157610a + pristine_git_object: 44e07fc91cd8de1bfaad6a481a3fa4d4f1c395d3 Codat/Lending/Models/Requests/ListBankingAccountBalancesResponse.cs: id: 7032630e15aa - last_write_checksum: sha1:0f91c4f0bb38c2f1fa1b459e4f6072e522897a0c - pristine_git_object: bf152af958669e2c26c5461e027e7026ad75a133 + last_write_checksum: sha1:6c465ddc0963db2b83190b7fe091dcc6c1f7e635 + pristine_git_object: c18721ae82bd723e43d21c658f77bea47d98aa4a Codat/Lending/Models/Requests/ListBankingAccountsRequest.cs: id: 549da18d4547 - last_write_checksum: sha1:abc947f026f22e1d117a0a57ff761760d8bdf992 - pristine_git_object: 0efdccd58c864b6e0443f4ac58c3b858d82f028d + last_write_checksum: sha1:cf877606320fa4b87221973b0eb7b210a6a76451 + pristine_git_object: 206dbed26e770602576aef25163494f2d1390ca7 Codat/Lending/Models/Requests/ListBankingAccountsResponse.cs: id: 99c7839ce49f - last_write_checksum: sha1:b0c0a1fe4d78aa221a931f3d264246df9a7d8855 - pristine_git_object: 416add0d2ee07b0c2eb1a7b70fdc121e4b0b2003 + last_write_checksum: sha1:e9eed95f5b3095b06690e46fcd555d4a034d0070 + pristine_git_object: 18da5e98b74e57e68066d8f0d4a91432c83559db Codat/Lending/Models/Requests/ListBankingTransactionCategoriesRequest.cs: id: 4c8f25c70c00 - last_write_checksum: sha1:241894235c2121163f2f2f2fc958290dd0619460 - pristine_git_object: 5b820345d120ba01d045ab6f0fa08c25e411a893 + last_write_checksum: sha1:8e83c03379af0620cc57b866953c8c24ed6f4d1c + pristine_git_object: 305fc267470e5b4c17276dec679c16a0437ed385 Codat/Lending/Models/Requests/ListBankingTransactionCategoriesResponse.cs: id: a76fd2891749 - last_write_checksum: sha1:d3c94a7240059fe15c6b8e69642099ee0a52c4cc - pristine_git_object: 1a6e2a129c4793eedc2249f9d6ff05ea153a1ca1 + last_write_checksum: sha1:de5ec3bf244afe4dcd39818e71af468bfa927a71 + pristine_git_object: 62b0d685e33ee93c418612882dfc43f28e16bd22 Codat/Lending/Models/Requests/ListBankingTransactionsRequest.cs: id: 19b6f1130588 - last_write_checksum: sha1:22cc68b7d4bc8bf37e6ea28d1c56f774ecc1c57a - pristine_git_object: ee7cf77a741be9677054fbd83d3c8544c27eec18 + last_write_checksum: sha1:3be38afc376f0995447570da3009aedb221a5213 + pristine_git_object: ed8a8898a34a1e9c43af2979816aa33cfea5b241 Codat/Lending/Models/Requests/ListBankingTransactionsResponse.cs: id: e00554fb1345 - last_write_checksum: sha1:efd58052b0be16604320c5fe668e8b916c375dba - pristine_git_object: 9b4e8ceb148b0e64e51c611858b43528494ea275 + last_write_checksum: sha1:609e524927a15dbc14e4a3e2009cb4e5dad945e3 + pristine_git_object: 8f1896b0a55107e20418da07c79cf5dac6628645 Codat/Lending/Models/Requests/ListCommerceCustomersRequest.cs: id: 7e59f2818c65 - last_write_checksum: sha1:38649d421c4cb1dd526b9997ac39aa26fa301424 - pristine_git_object: 0eb13d5fff4ed47ce09237046c797832f9b47581 + last_write_checksum: sha1:ae0d15f45131418d828bae20290c894cbb35c352 + pristine_git_object: d01fae726eb91bfb24b406f632a9d589fd60337f Codat/Lending/Models/Requests/ListCommerceCustomersResponse.cs: id: 40adc5fd7583 - last_write_checksum: sha1:2636119860ea8f382d21d6945aa45f594f0de2d3 - pristine_git_object: 0e7a3eb78528de02a63a0991b33f9a739dc4a4d1 + last_write_checksum: sha1:d2915f178fe4791f9593a33193317f677c221c40 + pristine_git_object: 1d85fa736020d96948dd11666301318726e18496 Codat/Lending/Models/Requests/ListCommerceDisputesRequest.cs: id: caef511d31b1 - last_write_checksum: sha1:19550267b5e0f2a79e488cec6db7079471a8655a - pristine_git_object: a8be235f7c30a889ecc9a862a937a6205597ceaf + last_write_checksum: sha1:69c66664b7c7a96725dccaef4610185b548883e3 + pristine_git_object: 494531183b7da57d83714d5cd4deea1ca8748b72 Codat/Lending/Models/Requests/ListCommerceDisputesResponse.cs: id: c95e3391d3f0 - last_write_checksum: sha1:07ff9ef649000774c41bf81e245bec3373b441e5 - pristine_git_object: d6ef9151c6fc6019fd0bd7d3c26d3c9135072109 + last_write_checksum: sha1:d13659a3240c5fd9be6384a51926c7a5d0a40e51 + pristine_git_object: 05b596a8cd0fca9df6504ca8d7fab8209e4b06ba Codat/Lending/Models/Requests/ListCommerceLocationsRequest.cs: id: 5d208af64e4d - last_write_checksum: sha1:164af4b448639cb222f11086253e59c5dad06be0 - pristine_git_object: 39b5cbba28693453be756ab5ead96dd08579428d + last_write_checksum: sha1:1dcaf5949dc4b12bcf82f8074558f4bc3e6ed699 + pristine_git_object: 8af79666c5a6bb50e19352dbdcb4221652fdc7c8 Codat/Lending/Models/Requests/ListCommerceLocationsResponse.cs: id: cf924a602ca2 - last_write_checksum: sha1:c99588938b9933f2246b6a395a88a097b909340e - pristine_git_object: c9d623410f6ed4d55567980d7819baba0639641c + last_write_checksum: sha1:e6c5d6137412482772cb6295a6e0d0a4065591ed + pristine_git_object: 42762f33535519379c10d7ce8daa6caba9a082b4 Codat/Lending/Models/Requests/ListCommerceOrdersRequest.cs: id: 839ecb53d2f5 - last_write_checksum: sha1:dda371ca1bbdb4ae16140959157cc72862d1b955 - pristine_git_object: 185e3ae03188ded47529404a512ca77c672a9dce + last_write_checksum: sha1:7b9fff54661f7aaa146f7685640959342e48b096 + pristine_git_object: 95bccfd523ff2e5286e6c7814d0420f0761f10ca Codat/Lending/Models/Requests/ListCommerceOrdersResponse.cs: id: fd0414d563f9 - last_write_checksum: sha1:f16b12485332e267c0e6c0a25b2aa789ec652eef - pristine_git_object: 6f09159e279c2a9842698142e26aabfcfc2f1198 + last_write_checksum: sha1:82948e267f55bdef5c0dc6e35cced34795300039 + pristine_git_object: 03d3cff19139c451e0fb7fb7a35ab892ae798345 Codat/Lending/Models/Requests/ListCommercePaymentMethodsRequest.cs: id: eff0a942d644 - last_write_checksum: sha1:68c340cd81b46373b8e381d069fffc79ed81cd7e - pristine_git_object: 507734f92c9e8de27fba5284c6cb7e093336a93a + last_write_checksum: sha1:8225f5d4c2dd9a1560820caaf582a1d92700923e + pristine_git_object: bbe729041f9b064ba062b65a7c2336992e15eacc Codat/Lending/Models/Requests/ListCommercePaymentMethodsResponse.cs: id: 0ed037a62a18 - last_write_checksum: sha1:0016325b0fd8c720eca2791fc4941ba14fbe0573 - pristine_git_object: 7e760ed27a41203a108a7a7095e318814930dfc5 + last_write_checksum: sha1:39a2f52e4e7f4a0f782b58e615a904fd6aebefb7 + pristine_git_object: 4fc5ec9c3c30c598cd8d2163e97d299821469189 Codat/Lending/Models/Requests/ListCommercePaymentsRequest.cs: id: 96b6becc8c46 - last_write_checksum: sha1:0652e1ffd8c9086cc5956b1b6957534eeb4c84ad - pristine_git_object: 6f998e7010447dfaa8575aba1d341c987e20e7dd + last_write_checksum: sha1:3b5a1004ba274d9053a2409bd0cc05534a3d0bc4 + pristine_git_object: c5ccb51a96d9bde4f32c67e4ed671cb091f14a6c Codat/Lending/Models/Requests/ListCommercePaymentsResponse.cs: id: 8b493b21f08d - last_write_checksum: sha1:83b27bcbb28ba61fd34335bd8d8337b73bf28968 - pristine_git_object: 67f23785c27e7f75f244bcb33d75e9c48b67eb8a + last_write_checksum: sha1:62b8fa0b61e55f733278c41869952033c0dddc5e + pristine_git_object: 7b5b763b314774c680565fe7c3239446c9493b69 Codat/Lending/Models/Requests/ListCommerceProductCategoriesRequest.cs: id: 1c9bfa976d63 - last_write_checksum: sha1:5a4740f6e6b430550cc6177e49b4a1746d297c54 - pristine_git_object: 4b1687cc707d611b2e9fc46570351cb4fc95d51c + last_write_checksum: sha1:cb843b8c6f174d946dc1bca15f26f6734fa2e28d + pristine_git_object: 9e74a6b7a76f03a40750359c4df8b5b5bd089ef6 Codat/Lending/Models/Requests/ListCommerceProductCategoriesResponse.cs: id: 91a8d20f42a3 - last_write_checksum: sha1:8a7c4cb564fabbc64aea91003f1bf18d37607722 - pristine_git_object: 9ac0d78f1300d03cb432ab6f8e80d0f718187a7e + last_write_checksum: sha1:db62d56ba50313f65702c203758ea602623b30c9 + pristine_git_object: 160d6f555d79f872de6806aeec54122e65538116 Codat/Lending/Models/Requests/ListCommerceProductsRequest.cs: id: ab36c4895543 - last_write_checksum: sha1:5f559ce5f7610feb8b55f4c6011ccc622ce08e88 - pristine_git_object: 45de7794aadc4f3539e40066f2fcd5ed69841699 + last_write_checksum: sha1:0434511ef5b55080c54ed97d924f127ec73bab8b + pristine_git_object: b8c8446e51b3f1cefcbb1559fdb23a125e26298d Codat/Lending/Models/Requests/ListCommerceProductsResponse.cs: id: 350637dffc95 - last_write_checksum: sha1:c83fae2c034567f32ae555c6982e54c56e96ab01 - pristine_git_object: d8f5bdf9053b74259cc8d4a072156f930ddd4cbe + last_write_checksum: sha1:52dbd1ac9a7d1a6221cc808edf2e62d707dfe826 + pristine_git_object: 739e6c6a4a13fdf5871f823b0678ae3c7efc2196 Codat/Lending/Models/Requests/ListCommerceTransactionsRequest.cs: id: 66ff776ac220 - last_write_checksum: sha1:2b80186fbf56cf94113349aec0790bb4ed3e66af - pristine_git_object: 2e2591cf5950e9f9bcc224946f92db28bd44aa5a + last_write_checksum: sha1:96805448403a5998c77d82f4638dbec37a75ee34 + pristine_git_object: 87d45d86a797c4af7b5f3abd4b9bb61dda0382bf Codat/Lending/Models/Requests/ListCommerceTransactionsResponse.cs: id: b887e637bd5e - last_write_checksum: sha1:4640446a88c3db741a7826ae20681482d623a8a3 - pristine_git_object: 5a4edbddfae65eb21cf284b5c2ac52932a6397dd + last_write_checksum: sha1:b9d4be0d823d6f201d1ececce85d5692ae7f9aa4 + pristine_git_object: 514ed015b3ba62507c3e01dd78c45038ad07e7e5 Codat/Lending/Models/Requests/ListCompaniesRequest.cs: id: 3aba8c663b56 - last_write_checksum: sha1:87e721bb01f9998912795bd7f480f45113206bd2 - pristine_git_object: d2ede601f1d60e93cdc7225839cdbcde841d1930 + last_write_checksum: sha1:c7d3f3561d4b193da427173522c4e5059c031d1c + pristine_git_object: 65e0db473bc95230930d6110389e4fa923bb4989 Codat/Lending/Models/Requests/ListCompaniesResponse.cs: id: 6bf8e70df1d1 - last_write_checksum: sha1:16a661a417089018b275cd5a11e1feaf66ea5e91 - pristine_git_object: fe6cdb6bd5504f739d7ddc4d9bd3e8962255bca7 + last_write_checksum: sha1:3da172613eecdc037aa24bb4d5aa34132aa1cdc7 + pristine_git_object: c82008a58bf300ca84be9f57d080dddd6553b042 Codat/Lending/Models/Requests/ListConnectionsRequest.cs: id: dc594bc48928 - last_write_checksum: sha1:35a3af058f017014546b34e5609a9c28c7cc5b39 - pristine_git_object: f7df8f9c2647dfbce7738e12658dfdea9d8acd74 + last_write_checksum: sha1:8485122f1292f4ff7a34525d15ddd6032f8eb09d + pristine_git_object: db9d9fcd3476d6811a859170cfc36578eeddc350 Codat/Lending/Models/Requests/ListConnectionsResponse.cs: id: b3fb0725e273 - last_write_checksum: sha1:48e8ac47312ff1d3080db80fbed6b264f4707795 - pristine_git_object: 62834e6de35f992deb6dc08c616ba5a1d2ab114f + last_write_checksum: sha1:61f727264b056b1aac5fb31e13fb3664858febef + pristine_git_object: 9294061d87e22af241efbd3af42cc44f38c9b3d3 Codat/Lending/Models/Requests/ListCreateOperationsRequest.cs: id: 52342f5c189e - last_write_checksum: sha1:8b07bbefe71612ffdd95eadbce47b874ef70e006 - pristine_git_object: fc28646ddf130d087d20cf755ff0e5dd9779733d + last_write_checksum: sha1:0537110db3aec7f3db3059df0e3ae252f6b21d14 + pristine_git_object: 9824d586f49df13c361be04dfc80ba716c2f6e6f Codat/Lending/Models/Requests/ListCreateOperationsResponse.cs: id: e6bf7891be3e - last_write_checksum: sha1:4f74de734f6f00e7402fa93cc91748e4da2a561f - pristine_git_object: 96991c384ce575f06db67f6a5cf131b7252730d2 + last_write_checksum: sha1:110234dff1b572c051539c51f343dde088450d9f + pristine_git_object: adbc29882de63b5f680f4c4e0e6d5da1731e294a Codat/Lending/Models/Requests/ListDataIntegrityDetailsRequest.cs: id: dfab477c6308 - last_write_checksum: sha1:6f59cc44c575aef2d25afd02ff6bd66bc2eca7a3 - pristine_git_object: a76c7d110ed45eae2b79c509eb7847b59b8240cc + last_write_checksum: sha1:853d7cd09db69e790c2d199b9f8410da87b6ace9 + pristine_git_object: 2d605bd662840f8a059541b6b22d5da345e5810f Codat/Lending/Models/Requests/ListDataIntegrityDetailsResponse.cs: id: e2a977014f0d - last_write_checksum: sha1:b3cadcf0383f3eb7cbc144abed1d5e2039c474e6 - pristine_git_object: 40ddedef9f944cb172c9e30037e4739092a1f2c2 + last_write_checksum: sha1:5773ec1d01c7ddab47f856b451031d9904eefc27 + pristine_git_object: 23937d02c1bc16e25262dcbabfb23de8f98f29fb Codat/Lending/Models/Requests/ListFilesRequest.cs: id: 882b7a2bc916 - last_write_checksum: sha1:adfa2786e01a92be21b8358f48c7916bad8e1a76 - pristine_git_object: a90146a4d61f768d5b2df89e25103a91402df011 + last_write_checksum: sha1:0ca963de7030b30e80355eb9c756e4fc2c3e836d + pristine_git_object: db75efc99eda27e4ce7ab3d8cdc0908915b7f9c9 Codat/Lending/Models/Requests/ListFilesResponse.cs: id: e27693afa1c6 - last_write_checksum: sha1:9905f10e74d8d8a6ea84e576fd257575f3d6cdb3 - pristine_git_object: f86341fa433a584a03add6c6e34ef839beafc48a + last_write_checksum: sha1:425cac8e07fe67e8eea0e89e49854b4d1973d6bb + pristine_git_object: 6966a1ea51fd9b22cc2cf67c8c8f767dcc75becc Codat/Lending/Models/Requests/ListLoanTransactionsRequest.cs: id: 7cc3fbd864a1 - last_write_checksum: sha1:d4ecb9ca368160349622bd588c5541162cd9c5ff - pristine_git_object: 0e6327775f9dd3e0afbf30ddd61e28fba4165087 + last_write_checksum: sha1:9f58abfc38a82fe1e2eac2e7612df37b19f46731 + pristine_git_object: b03596cdd43a09f8ece5cf59b1bd73d53c3aaefb Codat/Lending/Models/Requests/ListLoanTransactionsResponse.cs: id: aa80cf900246 - last_write_checksum: sha1:f40adca53d6c50a61f33ad9f85afe29fbcf1459e - pristine_git_object: fe901b404cf8874ba4bd0cdbd85b03093615620f + last_write_checksum: sha1:5b2ab7ed1babb7703e23277af00fbb94a118de8b + pristine_git_object: 9dcf9c1841a13c1265ac2dcb39887603239dd4a8 Codat/Lending/Models/Requests/ListPullOperationsRequest.cs: id: b1db9fb7cf00 - last_write_checksum: sha1:a5804e56e0e685efba5dec0334d7e0d1c84a0c12 - pristine_git_object: 391a3d3866f1899ce0d258050e1495329196f333 + last_write_checksum: sha1:85e991f35f725441cf2f1401b9b7185b6fc8d2e1 + pristine_git_object: 307af1eb427461e9b80dfbd09399e7949607fe1e Codat/Lending/Models/Requests/ListPullOperationsResponse.cs: id: f2020b252786 - last_write_checksum: sha1:78f766885d5dc6ab04d5ddc296f867e522bd9f6c - pristine_git_object: e82458e9ebd0a81df8243dfaf3aebb2469c97afa + last_write_checksum: sha1:848b8d2e8e58b779974da944e4fd101bded413b7 + pristine_git_object: 97a85adcc9c5edbbac5707b1362250e7e8e6dcb8 Codat/Lending/Models/Requests/ListReconciledInvoicesRequest.cs: id: 7f81c1840499 - last_write_checksum: sha1:812e4a0a3f17e014407af84840c0c3852374c507 - pristine_git_object: f896cbec383871b20c93d8bb15b67a3e43cf02b0 + last_write_checksum: sha1:d03cf01bfae8a150073522a4b6295859630d7092 + pristine_git_object: 4aed1063974e3090c0a9152c27c57b51497c4864 Codat/Lending/Models/Requests/ListReconciledInvoicesResponse.cs: id: 17df17cfda66 - last_write_checksum: sha1:f750eb1df7c3c64df8bf97f17d0da6c0c6098262 - pristine_git_object: faf56a007810753cb77054a6fd5c00f1d02eb61c + last_write_checksum: sha1:17e3c8ff49b74a9f1fe15d0a85013591d7ab8d22 + pristine_git_object: fa29b6eb1599206a4bdddc4cb84d0efa5886e050 Codat/Lending/Models/Requests/ListReportsRequest.cs: id: f4850d122f26 - last_write_checksum: sha1:1162ff49c02f7542879aec7361b3a6da339fda67 - pristine_git_object: b4dc5a1cc9145809cc59d3f948247506bb9a59ef + last_write_checksum: sha1:04604d012f1f3af3ce366aa560838b7ffa27297f + pristine_git_object: 8ce64c338d4d374ca78f64322cc7cf2bc2d11e78 Codat/Lending/Models/Requests/ListReportsResponse.cs: id: d0fd3f95a42d - last_write_checksum: sha1:07f78fe109a09992ff81c27acac48d4c8b93c185 - pristine_git_object: ceee4c11ac32f3836e49c92c793b6b8374b8ba46 + last_write_checksum: sha1:38d648444299426b87fa62794eee305e1e4569c4 + pristine_git_object: d9173c2f72955ae5fafd4a08b89f4f9e5e313c6c Codat/Lending/Models/Requests/QueryParamSourceType.cs: id: 4ce77a5a413f - last_write_checksum: sha1:21ade3d17fb26adeaa14364b25bfbb41524a9d2b - pristine_git_object: 270d092ebea4a9784e15f2439bf532377f9d9d0b + last_write_checksum: sha1:1da77d81813b27270d31223930304bc66a5014b7 + pristine_git_object: d10c0607f461a51b0047539d62da1df0b20e8086 Codat/Lending/Models/Requests/RefreshAllDataTypesRequest.cs: id: b8edc6d65e4a - last_write_checksum: sha1:e10ead38f7a723c5ca88198f56af94b55f9b7a83 - pristine_git_object: 6773864d06cb30372c4c2d1a2d7c3189102eef44 + last_write_checksum: sha1:c9d62c7156613552574c8b27116a7673685e1781 + pristine_git_object: 4b5ab834bf4f8b3fe8470ffcf630460cafbc9952 Codat/Lending/Models/Requests/RefreshAllDataTypesResponse.cs: id: 3661397b45e6 - last_write_checksum: sha1:b3964cd9f3ea0d32fc66050fdebfaf3baa6373d8 - pristine_git_object: 28a20ca3fb51388e0fad83b2a8f11bd5faf822ec + last_write_checksum: sha1:b81c89cd10000cf18bfa93b8d85abd5ab6b59240 + pristine_git_object: 5a2bdf08cf9bcba4cee2d84441f9980e10c935e5 Codat/Lending/Models/Requests/RefreshDataTypeRequest.cs: id: 84e620288d2a - last_write_checksum: sha1:d0a14e9b092ffe256d303c2bc65f1e729fce4b65 - pristine_git_object: 1746edd68f5e28df209aa795d660670a3124bea5 + last_write_checksum: sha1:3a31a1ec22a49c48dbfd8ed7d488c732b666e8ba + pristine_git_object: 18d89afda196f5b1cd626cc0199661a77fed328f Codat/Lending/Models/Requests/RefreshDataTypeResponse.cs: id: d8e88fe95154 - last_write_checksum: sha1:605c7a254aba19d6aa1d3ba3fc2ae75213935606 - pristine_git_object: e2e90866c1921035d6f64971b96619745396de78 + last_write_checksum: sha1:36e55ec6bdf449459ab2163aec26d7bb5b3bed59 + pristine_git_object: eec41a34fdc1d1fbb43055430ffaf2b3a4a7e305 Codat/Lending/Models/Requests/ReplaceCompanyRequest.cs: id: c5d6fe388da5 - last_write_checksum: sha1:4919deef35a44f2596b88e2f67c146960ebafaa8 - pristine_git_object: 853c3ccf84502d8342e6a2a88069368e68ecb344 + last_write_checksum: sha1:a8b7e0e030ffa4a41d4d3f4217ab9d3fbeb8ed23 + pristine_git_object: cd5a55fcadd369dfba725dd716a6db5bd5c83043 Codat/Lending/Models/Requests/ReplaceCompanyResponse.cs: id: b6ff47774491 - last_write_checksum: sha1:fcea7a90d5d12c627e278be0c4a6213ab1689274 - pristine_git_object: 7a9e9db84dadb1fb53ece1e3a3ecd2eb6152b9c4 + last_write_checksum: sha1:e8ed83f57f94d20dcb0b6b62859c27bce2f8acfd + pristine_git_object: ba0d984454ac2a95fc2a611812f92333d106b937 Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationRequest.cs: id: e8f0c9aadcec - last_write_checksum: sha1:9859900e4de09619cfba39fa50ca7164393bf915 - pristine_git_object: 0cd4c12c2ab4e3698adc483d0be1004c48400d1e + last_write_checksum: sha1:d9592427c898e837821d1f2141625c05c11bf20a + pristine_git_object: cbd9f6bb9571693293b088547a74d5d6b163ac0d Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationResponse.cs: id: 4a9b939f0c5f - last_write_checksum: sha1:104d3d78c12e14ae0b5c18c291d447340c4cc283 - pristine_git_object: 1705fd31851416f6c56f4cadf424b008ac30adac + last_write_checksum: sha1:d98a0db1435bcda591971b9e5329a678cf8738fb + pristine_git_object: 7df947fbad082b9da2d360383c8e28cfed190178 Codat/Lending/Models/Requests/SourceType.cs: id: cc7461eb8321 - last_write_checksum: sha1:ae3376e07aebde46181830a696b1599c8a9f15e9 - pristine_git_object: 5824b9982d08183bbb45d8c310f95e53641ff438 + last_write_checksum: sha1:d297dcf68f25b3924e43f0f3a1c52ad186a25f33 + pristine_git_object: 961b2ac8e54e625c631aae01ed9d8c8f28166e1c Codat/Lending/Models/Requests/StartBankStatementUploadSessionRequest.cs: id: 3cf4d628d4b7 - last_write_checksum: sha1:853fd24cf48e71d0aad144ac692105d4c508c82a - pristine_git_object: 900372251f4724d564f5011647e77c37f009d3e4 + last_write_checksum: sha1:07249b4243e8822f151aa4c552dfc74220d5f77c + pristine_git_object: 14215cf8e585e054af05a54a190c82d31ae1b98c Codat/Lending/Models/Requests/StartBankStatementUploadSessionResponse.cs: id: 3727195b932e - last_write_checksum: sha1:7953cc2205c3bb4d274d8be448107bcc5ad489f8 - pristine_git_object: c73fa52bab3216c24dccd342f0a0aff1f5dac62b + last_write_checksum: sha1:1b1a1296221be96608a8a1d2e0dc6c4b28213e50 + pristine_git_object: 8c08218dd54463d71e400f6cdb50ef131b594d66 Codat/Lending/Models/Requests/UnlinkConnectionRequest.cs: id: 586bf984602a - last_write_checksum: sha1:06aaedf71b9593ede22bfc5e8984d5da87ca59c7 - pristine_git_object: e7726440b2b28fa1abd11d480b12a655f1dbb46e + last_write_checksum: sha1:dea797ae93174f051af271cf4aad3a58e17f2cf5 + pristine_git_object: 362c1a90e123741f2d5cfc2368c7c413c19c79b5 Codat/Lending/Models/Requests/UnlinkConnectionResponse.cs: id: 2f5cdfcdc760 - last_write_checksum: sha1:5438a4df19737bb0b93f7eba4438272ea521af77 - pristine_git_object: 17fe76af52441c858e4188dcfa3edebea510309b + last_write_checksum: sha1:857023bcc5f29c5407674e18239911373e22ae48 + pristine_git_object: 6c5ab4440d076063babbd88d5776655c15acf514 Codat/Lending/Models/Requests/UnlinkConnectionUpdateConnection.cs: id: e554073a2160 - last_write_checksum: sha1:e4e6d4d903d87a9754f6440c12b488a26ae57564 - pristine_git_object: 15fe5fc5134063427635713c21273a979eb88f95 + last_write_checksum: sha1:dbb61a35c857cddf968a5af4dd6e02316e2eaa80 + pristine_git_object: 62bba018fd0896fbc4c99c79195f4fa5ddd4e8be Codat/Lending/Models/Requests/UpdateCompanyRequest.cs: id: 88d9ed2135fa - last_write_checksum: sha1:c82a7ffd612105bb932a14e91281277a65dc748f - pristine_git_object: cb74612d623b18e3347c0667fc64e5a531f83717 + last_write_checksum: sha1:eae551417cb8e0e81bd6e0691776ab5a53864b4d + pristine_git_object: fef641c2224385c96129d4d84df576d1ece8071d Codat/Lending/Models/Requests/UpdateCompanyResponse.cs: id: 42892b13b5a5 - last_write_checksum: sha1:0c7aabb1f054ac050e711d4b8057fb641b7343a9 - pristine_git_object: ba5f23b6efc9ca19fd039bd13f665df8d08abbed + last_write_checksum: sha1:cc9695366d1f9e8236f7faf78232658e6a00e8a0 + pristine_git_object: 97719fee3eae4b311f38d758cb8db5bd482db7b9 Codat/Lending/Models/Requests/UploadBankStatementDataRequest.cs: id: e481249deb08 - last_write_checksum: sha1:44f2c7bac5127d6da2a450b34fd4c05d4897e253 - pristine_git_object: 41c75ff903043b63b46fc9c5b92064059adf9bc2 + last_write_checksum: sha1:f3fc4b13911815ac217eaa4e47d4785b0a75ea98 + pristine_git_object: 8c07314fcdb1f1477c94269c0e28dbd2dea0f8d3 Codat/Lending/Models/Requests/UploadBankStatementDataRequestBody.cs: id: 06d429a2dcae - last_write_checksum: sha1:a91151bbccf1aaa56848bda59a5f53b250f190ac - pristine_git_object: de882e74252b30032bc07a20f246da410a53a3b0 + last_write_checksum: sha1:ae530473656f7a7dd9749ee38c4650897d3b5e89 + pristine_git_object: 37b0c75f94d8472a6827ebd8daf200731a56f610 Codat/Lending/Models/Requests/UploadBankStatementDataResponse.cs: id: a139ba08d1a6 - last_write_checksum: sha1:7f2fd887aa5efc0a9845bd5f96d9d802048d98c6 - pristine_git_object: 89748b03bb35f2a0b86d23c12fa8d8bc38fa5aa2 + last_write_checksum: sha1:6c317e81fee94c6f9afa753673eb69d0513bfb7a + pristine_git_object: b3432633ca9ef75fac5f68cf7aa53e36e64f1d46 Codat/Lending/Models/Requests/UploadFilesRequest.cs: id: 4f34506dd838 - last_write_checksum: sha1:3e5767dff86b40edaeab767603850f415b588fdc - pristine_git_object: bfddd7873945f1bb35003ebb692343e9f8677320 + last_write_checksum: sha1:affdbff906376d4de1546724e9ba055c536db7b9 + pristine_git_object: a7a60c3ca4bb17f68d8c33ab57d43f6f94fa07be Codat/Lending/Models/Requests/UploadFilesResponse.cs: id: 24a9072e041d - last_write_checksum: sha1:243d217b44b2fde2f4d8c3a7fe88d3ea0e9e0c5b - pristine_git_object: 755abd22ad011ae4183b0421e6497a03a1711022 + last_write_checksum: sha1:492b8979767bc26583db977d62f6742a9c237f46 + pristine_git_object: 0efadefa8f70255a684d566227696c9e60592be3 Codat/Lending/Models/Webhooks/AccountCategoriesUpdatedResponse.cs: id: 2724f29dbed2 - last_write_checksum: sha1:442427a3c8707721219bf5879f1f5f696ce1f89c - pristine_git_object: d64fe5e200a7060ec3c4483e8655496c6123c172 + last_write_checksum: sha1:850025f5aa1ad7d01c1986455b6e981802a211cd + pristine_git_object: 8f26c9161b1cb1d28cb199cff75c706e305c6eb1 Codat/Lending/Models/Webhooks/ClientRateLimitReachedResponse.cs: id: 6e2eb4cc763f - last_write_checksum: sha1:eaf4171da63967829f0ebbd2e22d0610dad81d16 - pristine_git_object: c5c680f2f9bb3f02e927890c2c525b32dc99632c + last_write_checksum: sha1:1c74243c9a4b4a83a3bee5910738af5e46ed660a + pristine_git_object: b7c471c4cb320380a212039e80b4b5e806a59ace Codat/Lending/Models/Webhooks/ClientRateLimitResetResponse.cs: id: bd3bd2fb0c09 - last_write_checksum: sha1:9e2c166b4a902a9fe4a9bc18ad6c99607488e4cf - pristine_git_object: efeb8ca555e44f73793d3b2b74a6336c2c711a7a + last_write_checksum: sha1:9e05c985f327e060e6ea366d9ccee1b905b60d03 + pristine_git_object: 5812630ac219c04f19a6f835107c2221d38cc1a1 Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateSuccessfulResponse.cs: id: 618bbd0ba146 - last_write_checksum: sha1:d127b5203cb0083ab1319c6809cdb761ddd1b79d - pristine_git_object: fdcf60bf87353c9c7625d993785b4f59f78defa2 + last_write_checksum: sha1:8b8eef85eff6aca548c95635f0672605ed36ffdb + pristine_git_object: 9b58daf789a7a86bf0331e147d85110178202792 Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateUnsuccessfulResponse.cs: id: 5cf2676f61e0 - last_write_checksum: sha1:9cfb340cb8e4ade3db2d23c6c067562acb4f1465 - pristine_git_object: 1efbe31b123b9674f32cae2fd40ffcc8374d32c6 + last_write_checksum: sha1:cd0b5cec7eaf97c80fd4ded1146efd6331a7a743 + pristine_git_object: b25f66f268cf13da7b2b7f2fb9eab16a6c815298 Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.cs: id: 7d0c5735f2a2 - last_write_checksum: sha1:6f202d3ac85946fbc00cd406141a4f338edc062f - pristine_git_object: 7451b6202159f87b6f3435903086c3647246e0a7 + last_write_checksum: sha1:bcad56ac0101a021cac78e630462a5a9a1a79ea6 + pristine_git_object: cf35b456d014bbbafc5e022dcdd94212edf35927 Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulResponse.cs: id: 0bab5b98d8a4 - last_write_checksum: sha1:095a315150161d38cb829b8bb77e16727b2d328b - pristine_git_object: bcf15c9bb4433fd7781ee2077f9c67ea45eaffda + last_write_checksum: sha1:11f5e87028682ab4b1ceacdfbc6a356c5597e9ea + pristine_git_object: 58c4694a7d956c45698ab1f17729ee3b22cc1743 Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateUnsuccessfulResponse.cs: id: edf19b87455b - last_write_checksum: sha1:98895439016a69b990b636fa9eb7de308e5a08b1 - pristine_git_object: 7ca6082a5022a68c0376bfe5ae4d5e91ecd0a0b4 + last_write_checksum: sha1:d41eaa89d3e01e322c57845581a0b300f4921106 + pristine_git_object: de051e5456b1eaa5f157af38b897d26cb7531d5c Codat/Lending/Orders.cs: id: ff6d031b4fe6 - last_write_checksum: sha1:0e297c21d41c222a739f6fb0860cfc10c7c68062 - pristine_git_object: 71a2acb069e0b6055df71aa48938cc6087fadeea + last_write_checksum: sha1:27b1c15bfe60f3044df6de193c157e5e1ceeadac + pristine_git_object: 60835c37b34a11543e5def7a6bcf033b98414d61 Codat/Lending/PaymentMethods.cs: id: ab99cea4d371 - last_write_checksum: sha1:fdd64930fd30db16adbb44356b26fa5e78c07532 - pristine_git_object: 1ae08a2eaf62457e1a9f60a2e49c22f59299e755 + last_write_checksum: sha1:46df6540dd74ba476545623801dfab3ba7728384 + pristine_git_object: 24e2ce2d33fd5c1a1c426047513a93e0f0207b73 Codat/Lending/Payments.cs: id: 4b71bad22fd4 - last_write_checksum: sha1:df328163de18d054d1486d112c06f5f72bfa5bda - pristine_git_object: e9abb4dbf398d50d6e42c986dd835a36f999efc4 + last_write_checksum: sha1:1fe955a268fb55a0dbf419378b5e2a3a2328985e + pristine_git_object: f08f6a8b35ef9daf2d54ec004a41186791c3cd29 Codat/Lending/ProductCategories.cs: id: eb90b39516b7 - last_write_checksum: sha1:ddd463a3322c1ab79a2b8b9927a5e037a83ed7be - pristine_git_object: 22d2757f50b7f41f8c9520fe26df0f0d68aa2c7a + last_write_checksum: sha1:9a8ae97b86a68b3aa712cef367a4b05624eea9c1 + pristine_git_object: 818bc821aab0ca41b21befd62e5fb5c17bab865a Codat/Lending/Products.cs: id: b4e7bf592db4 - last_write_checksum: sha1:8ef84fad166f0bf058736b43df4fb26b4e3d9a9e - pristine_git_object: 43304ff4e85a68ef93b4dcbcee25a7a28fc1f563 + last_write_checksum: sha1:da5838d2f221fc0272f25b322e6ac54dec368af1 + pristine_git_object: c9ecff241c1279f97b54508791d4e4b3b73768c2 Codat/Lending/ProfitAndLoss.cs: id: 9c541445abde - last_write_checksum: sha1:29d522c9f672da4dcd3907689fe2511037aea909 - pristine_git_object: 4dd571233a032e60e069e1951131bf2270e7d85b + last_write_checksum: sha1:61c470f841e3c754181591d1620782d1eed145b0 + pristine_git_object: 25a1ac27dbfe908101e4d38f011e94f6fd886aaf Codat/Lending/PullOperations.cs: id: 4c5865cd974a - last_write_checksum: sha1:f76f211221c702778eec1141e176acb8c6c93f11 - pristine_git_object: 3a8f07c3f10455f62ec6745a97b501687d60b153 + last_write_checksum: sha1:73461b2735f43a786a30640786b999400b907782 + pristine_git_object: d922614576c0d37a1deddd9222d7005b63e85c37 Codat/Lending/Refresh.cs: id: 9d21f2171509 - last_write_checksum: sha1:cc894d2b239342ea5bdefdbd7515ce5395f9b655 - pristine_git_object: df7ed55dc75f83d1e19e4b6c532619905918d92c + last_write_checksum: sha1:302e67045e1b09f21d50064c8305ab53792fcd24 + pristine_git_object: 30a98c0c1a71738bacb96f211974ff6e985bf339 Codat/Lending/Reports.cs: id: f56dbb5f4e95 - last_write_checksum: sha1:df174911a63e4f1158782335074af114bdad1723 - pristine_git_object: 3001b7876e20102de36e379db803e209a1936ce9 + last_write_checksum: sha1:938858f84021aac3c6b763c880095cbe072e5cfc + pristine_git_object: ce5270d74e9c35cef091a06d37f55e85298fd9f1 Codat/Lending/SDKConfig.cs: id: 2ede6f8ed1c1 - last_write_checksum: sha1:fa5e998381a0f0b1b694542d986ffde5638797fb - pristine_git_object: cf2683a81f115f15fcf1357f83c1ef5cf865e3fb + last_write_checksum: sha1:ad3354081807cdcde9fa9074bfc8b115c5723909 + pristine_git_object: 7f68a004305b56749f4173597d122f3e4f1c0d88 Codat/Lending/Sales.cs: id: c60ae2e87856 - last_write_checksum: sha1:1d49a5dc30f16508e1358b160c9527874bd6ca8f - pristine_git_object: 77acc24b89a6e9f3ea8c9b1074625cfba9d2458e + last_write_checksum: sha1:1d18339426725ea721558696ee61c38a687cd38b + pristine_git_object: 9ed0ed36c2dd0b984239db6bcdd413d466f01fe9 Codat/Lending/SourceAccounts.cs: id: 46ac67c5e94c - last_write_checksum: sha1:5a330cebc592c8e84054eb0b666b8c58407c963a - pristine_git_object: af63d10152ed7ed8ee79afcfcba6a95fe08bb11b + last_write_checksum: sha1:b93196d4126073c59c9fcb48d2b3559680c1de54 + pristine_git_object: b0f1c8b0d96cce5fd197d60638a43ea070009876 Codat/Lending/Suppliers.cs: id: 063fbcd90dba - last_write_checksum: sha1:54b43e48d8e7fd2bbc1dd63f46ece788293c2643 - pristine_git_object: 1ca1de2000dd122716d0cfb96de6d3fb8a3d18b2 + last_write_checksum: sha1:5f56b7fe2e552d48cdbae9f4fc49f2b5ce38cb79 + pristine_git_object: d2cc8276e8a7c9ba36f43a8d66ed6942a8432d36 Codat/Lending/TransactionCategories.cs: id: e49cd947d886 - last_write_checksum: sha1:429304cb2e21f7c4d8aaca7d35a00ed0e9856baa - pristine_git_object: 2547415df6ba257910acc5dee588202a44244d59 + last_write_checksum: sha1:3696161a65c29ab29f1c33983112d24b28fb9f49 + pristine_git_object: 902f309954ea3a76ebafa0627d773bb4d279ab6e Codat/Lending/Transactions.cs: id: fc1202f0120c - last_write_checksum: sha1:813e0919a9fdafc9a85dd801b605031738d8c0d4 - pristine_git_object: e8c0f639d603083a7efa8553a027f7e91b1f9451 + last_write_checksum: sha1:2775f47dee23900a3b3f09795972371cc14f3228 + pristine_git_object: 0df74a164f57a764d2c51591e73e85c96d964aa5 Codat/Lending/Transfers.cs: id: 9922ab40c248 - last_write_checksum: sha1:043912ea0f62613410d6e82f9a47a649b5e7307a - pristine_git_object: b97bc07851d6a3119ea827e4637e256c198adfb3 + last_write_checksum: sha1:95a03806e31c5270adb341a71168b2a46fdf6918 + pristine_git_object: ea28a7660685ad56e94f81a9d379fd62c372298a Codat/Lending/Utils/AnyDeserializer.cs: id: a13f585d1274 last_write_checksum: sha1:1b10199c54905d6881cee0b84cbe06b1ea2b53c6 @@ -3005,8 +3005,8 @@ trackedFiles: pristine_git_object: 1320db9c86e76521ca451a9223547cad0533d441 Codat/Lending/Utils/Constants.cs: id: 900b1be46e7b - last_write_checksum: sha1:2db17d4d34f392bb8152bfc557adbf13fbecf2a3 - pristine_git_object: 6b9c37f103ef9e846cd1b40123af4906ede1ef7b + last_write_checksum: sha1:f8662f9be653157e1dbde4b1ce81d3199047b43f + pristine_git_object: 09dce91e67f7318c9ad3b94cdc4b95ce06c820c2 Codat/Lending/Utils/DecimalStrConverter.cs: id: 0596aaaffa75 last_write_checksum: sha1:b91014c9bf3b57b5ee79ff16c9d7b9a90626900a @@ -3041,16 +3041,16 @@ trackedFiles: pristine_git_object: 47b1af03d18ffc2ab16d3c9e4264548f1e27232e Codat/Lending/Utils/Retries/BackoffStrategy.cs: id: f11a2df1fddc - last_write_checksum: sha1:77169e65e6fbd941781e98056ecaa6f653ae2eea - pristine_git_object: 91fcf71b21f125f2b6c97d930dee067d544e4a7c + last_write_checksum: sha1:8c89365d4552ad5ada5bc1c8a755c6529952ea0f + pristine_git_object: b3f313ecfbad32d670da8c1874dcffa94b9da4b7 Codat/Lending/Utils/Retries/Retries.cs: id: 3a61cd4ff046 - last_write_checksum: sha1:aeedd2a40de12230b9f0e1b9f647803e18275836 - pristine_git_object: 12a98fee8d20868ed2b002a6c7f5d3a04889e252 + last_write_checksum: sha1:e42593329d1ad4039d9926d6bd1e98744481fceb + pristine_git_object: 26a1023f806ba299a29b3a7b957a3d3fa1350d10 Codat/Lending/Utils/Retries/RetryConfig.cs: id: 4eb4b5c367b5 - last_write_checksum: sha1:2bb0dbcc9279853807a61f23bbbec4291649585c - pristine_git_object: e9ba0faa580852e44c2274151f837637e6c96f0e + last_write_checksum: sha1:2048da5b846720da6b2cf7b7524bd8f977c77278 + pristine_git_object: d5b5fc2f9b3ddd20eda242a97c95a5c9896115ec Codat/Lending/Utils/SecurityMetadata.cs: id: e9165d12aaeb last_write_checksum: sha1:3d3bbef9f1ea08a94621218d3fa6e4de321d13b3 @@ -3069,8 +3069,8 @@ trackedFiles: pristine_git_object: 9dfc5823e8a44d881719d884bd9016278bb47f79 Codat/Lending/Utils/Utilities.cs: id: 6bc66c64b725 - last_write_checksum: sha1:96eb85ee54347b3e2b07561cd3ccee54e3ccdb79 - pristine_git_object: 633726d1bed69eff19b94eb62a9879a607cd533e + last_write_checksum: sha1:74fae61e5734d8d0fed376be418689c10d6321a1 + pristine_git_object: ee59d7c1ab41b221b180b912083484f52c12b485 NUGET.md: id: f4c8a442a6e5 last_write_checksum: sha1:1a1a1590fbfb948e7e1814a4d7bfa79da4ed571e @@ -3569,8 +3569,8 @@ trackedFiles: pristine_git_object: 5ca3553f5e8aaa3c4ccfb00c177db597a8b6e1b1 docs/Models/Components/CashFlowTransaction.md: id: 5ed186e67ea2 - last_write_checksum: sha1:0e9e49d8d5a6aa6608d299c2f4fc13cba44e5913 - pristine_git_object: 001eabc44d30d2f4d7a89a7c2fce7d93ddb5f703 + last_write_checksum: sha1:f6c0ca457bb79b5de2eaa75fd3e78703e7923b6f + pristine_git_object: 33ba6e46402bbf6d9417a455bbca9951f46f648f docs/Models/Components/ClientRateLimitWebhook.md: id: 76c3a2ac70a1 last_write_checksum: sha1:59cbfbd15031c073b3d5c956ade4bc14fc9ec9dc @@ -5761,8 +5761,8 @@ trackedFiles: pristine_git_object: bc7cbc169a70cbf0fc3e42add389a78cc698cf72 docs/sdks/bankstatements/README.md: id: 367be2ea83cc - last_write_checksum: sha1:0648728801e75242e9d56fc173d0074e01b9ec41 - pristine_git_object: bff53b95f76aeac8cb95f0843f6501121d726d19 + last_write_checksum: sha1:f56af94dd5fbea65d3fc10646f656ad6bb11532e + pristine_git_object: 1ae8e569255a8eeb8ceb2051af467fda4812a165 docs/sdks/banktransactions/README.md: id: 4d2b2b0db893 last_write_checksum: sha1:6d24410cee953027ec315ac39a72b0905aefdbab @@ -17519,7 +17519,9 @@ examples: application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## Csharp SDK Changes:\n* `Codat.lending.Loan-Writeback.Source-Accounts.Create()`: \n * `request.RequestBody` **Changed** **Breaking** :warning:\n* `Codat.lending.Companies.List()`: `response.results.[].DataConnections.[].ConnectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Companies.Create()`: `response.dataConnections.[].ConnectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Companies.Update()`: \n * `request` **Changed** **Breaking** :warning:\n * `response.dataConnections.[].ConnectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Companies.Get()`: `response.dataConnections.[].ConnectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Connections.List()`: `response.results.[].ConnectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Connections.Create()`: `response.connectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Connections.Get()`: `response.connectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Connections.Unlink()`: `response.connectionInfo.{}` **Changed** **Breaking** :warning:\n* `Codat.lending.Manage-Data.Refresh.All-Data-Types()`: `error.status[400]` **Added**\n* `Codat.lending.Companies.Replace()`: **Added**\n* `Codat.lending.Manage-Data.Refresh.Data-Type()`: `error.status[400]` **Added**\n* `Codat.lending.Financial-Statements.Profit-And-Loss.Get()`: `response.currency` **Changed**\n* `Codat.lending.Financial-Statements.Balance-Sheet.Get()`: `response.currency` **Changed**\n* `Codat.lending.Financial-Statements.Cash-Flow.Get()`: `response.currency` **Changed**\n* `Codat.lending.Transactions.Journal-Entries.List()`: `response.results.[].JournalLines.[]` **Changed**\n* `Codat.lending.Transactions.Journal-Entries.Get()`: `response.journalLines.[]` **Changed**\n* `Codat.lending.Accounts-Payable.Bills.List()`: `response.results.[].LineItems.[]` **Changed**\n* `Codat.lending.Accounts-Payable.Bills.Get()`: `response.lineItems.[]` **Changed**\n* `Codat.lending.Manage-Data.Get-Status()`: `response.accountTransactions.LastSuccessfulSync` **Changed**\n* `Codat.lending.Loan-Writeback.Source-Accounts.Create-Mapping()`: \n * `request.BankFeedBankAccountMapping.FeedStartDate` **Added**\n* `Codat.lending.ManageReports.Generate-Report()`: `error.status[409]` **Added**\n" +releaseNotes: | + ## Csharp SDK Changes: + * `Codat.lending.Banking.CategorizedStatement.Get()`: `response.reportItems[].Transactions[].IsRecurring` **Added** generatedFiles: - .gitattributes - CONTRIBUTING.md diff --git a/lending/.speakeasy/gen.yaml b/lending/.speakeasy/gen.yaml index 66e08ad3e..5b45ac7cc 100644 --- a/lending/.speakeasy/gen.yaml +++ b/lending/.speakeasy/gen.yaml @@ -21,13 +21,14 @@ generation: schemas: allOfMergeStrategy: shallowMerge requestBodyFieldName: "" + versioningStrategy: automatic persistentEdits: {} tests: generateTests: true generateNewTests: false skipResponseBodyAssertions: false csharp: - version: 10.0.0 + version: 10.0.1 additionalDependencies: [] author: Codat baseErrorName: CodatLendingException diff --git a/lending/Codat/Lending/AccountBalances.cs b/lending/Codat/Lending/AccountBalances.cs index 3e5e178b3..ea8c7a409 100644 --- a/lending/Codat/Lending/AccountBalances.cs +++ b/lending/Codat/Lending/AccountBalances.cs @@ -24,37 +24,65 @@ namespace Codat.Lending public interface IAccountBalances { - /// - /// List account balances - /// + /// List account balances. + /// /// - /// The *List account balances* endpoint returns a list of account balances for a given company's connection.
+ /// The *List account balances* endpoint returns a list of account balances for a given company's connection.
///
/// Account balances are balances for a bank account, including end-of-day batch balance or running balances per transaction.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListBankingAccountBalancesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListBankingAccountBalancesRequest request, + RetryConfig? retryConfig = null + ); } public class AccountBalances: IAccountBalances { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public AccountBalances(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListBankingAccountBalancesRequest request, RetryConfig? retryConfig = null) + /// + /// List account balances. + /// + /// + /// The *List account balances* endpoint returns a list of account balances for a given company's connection.
+ ///
+ /// Account balances are balances for a bank account, including end-of-day batch balance or running balances per transaction.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListBankingAccountBalancesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -114,7 +142,7 @@ public async Task ListAsync(ListBankingAccou httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -218,5 +246,6 @@ public async Task ListAsync(ListBankingAccou throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/AccountTransactions.cs b/lending/Codat/Lending/AccountTransactions.cs index ff63f6241..68331c6e1 100644 --- a/lending/Codat/Lending/AccountTransactions.cs +++ b/lending/Codat/Lending/AccountTransactions.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IAccountTransactions { - /// - /// List account transactions - /// + /// List account transactions. + /// /// - /// The *List account transactions* endpoint returns a list of account transactions for a given company's connection.
+ /// The *List account transactions* endpoint returns a list of account transactions for a given company's connection.
///
/// Account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingAccountTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingAccountTransactionsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get account transaction - /// + /// Get account transaction. + /// /// /// The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.
///
/// Account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingAccountTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingAccountTransactionRequest request, + RetryConfig? retryConfig = null + ); } public class AccountTransactions: IAccountTransactions { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public AccountTransactions(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingAccountTransactionsRequest request, RetryConfig? retryConfig = null) + /// + /// List account transactions. + /// + /// + /// The *List account transactions* endpoint returns a list of account transactions for a given company's connection.
+ ///
+ /// Account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingAccountTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccou httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccou throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingAccountTransactionRequest request, RetryConfig? retryConfig = null) + + /// + /// Get account transaction. + /// + /// + /// The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.
+ ///
+ /// Account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingAccountTransactionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountin httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountin throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/AccountingBankData.cs b/lending/Codat/Lending/AccountingBankData.cs index d9db9159b..1f29f351a 100644 --- a/lending/Codat/Lending/AccountingBankData.cs +++ b/lending/Codat/Lending/AccountingBankData.cs @@ -28,20 +28,28 @@ namespace Codat.Lending public interface IAccountingBankData { public ICodatLendingAccounts Accounts { get; } - /// - /// List bank account transactions - /// + /// List bank account transactions. + /// /// - /// The *List account bank transactions* endpoint returns a list of bank account transactions for a given company's connection.
+ /// The *List account bank transactions* endpoint returns a list of bank account transactions for a given company's connection.
///
- /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
+ /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListTransactionsAsync(ListAccountingBankAccountTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListTransactionsAsync( + ListAccountingBankAccountTransactionsRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -49,12 +57,16 @@ public interface IAccountingBankData /// public class AccountingBankData: IAccountingBankData { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// Accounts SubSDK. + /// + /// public ICodatLendingAccounts Accounts { get; private set; } public AccountingBankData(SDKConfig config) @@ -63,7 +75,28 @@ public AccountingBankData(SDKConfig config) Accounts = new CodatLendingAccounts(SDKConfiguration); } - public async Task ListTransactionsAsync(ListAccountingBankAccountTransactionsRequest request, RetryConfig? retryConfig = null) + /// + /// List bank account transactions. + /// + /// + /// The *List account bank transactions* endpoint returns a list of bank account transactions for a given company's connection.
+ ///
+ /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListTransactionsAsync( + ListAccountingBankAccountTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -123,7 +156,7 @@ public async Task ListTransaction httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -227,5 +260,6 @@ public async Task ListTransaction throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Accounts.cs b/lending/Codat/Lending/Accounts.cs index 608234abf..2782c2d55 100644 --- a/lending/Codat/Lending/Accounts.cs +++ b/lending/Codat/Lending/Accounts.cs @@ -24,50 +24,88 @@ namespace Codat.Lending public interface IAccounts { - /// - /// List accounts - /// + /// List accounts. + /// /// - /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
+ /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
///
/// Accounts are the categories a business uses to record accounting transactions.
///
/// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingAccountsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingAccountsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get account - /// + /// Get account. + /// /// /// The *Get account* endpoint returns a single account for a given accountId.
///
/// Accounts are the categories a business uses to record accounting transactions.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingAccountRequest request, + RetryConfig? retryConfig = null + ); } public class Accounts: IAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Accounts(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingAccountsRequest request, RetryConfig? retryConfig = null) + /// + /// List accounts. + /// + /// + /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingAccountsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -127,7 +165,7 @@ public async Task ListAsync(ListAccountingAccoun httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -232,7 +270,29 @@ public async Task ListAsync(ListAccountingAccoun throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingAccountRequest request, RetryConfig? retryConfig = null) + + /// + /// Get account. + /// + /// + /// The *Get account* endpoint returns a single account for a given accountId.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingAccountRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -292,7 +352,7 @@ public async Task GetAsync(GetAccountingAccountReq httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -396,5 +456,6 @@ public async Task GetAsync(GetAccountingAccountReq throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/AccountsPayable.cs b/lending/Codat/Lending/AccountsPayable.cs index e0b036df1..3a6da9a2e 100644 --- a/lending/Codat/Lending/AccountsPayable.cs +++ b/lending/Codat/Lending/AccountsPayable.cs @@ -17,22 +17,44 @@ namespace Codat.Lending public interface IAccountsPayable { public IBillCreditNotes BillCreditNotes { get; } + public IBillPayments BillPayments { get; } + public IBills Bills { get; } + public ISuppliers Suppliers { get; } } public class AccountsPayable: IAccountsPayable { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// BillCreditNotes SubSDK. + /// + /// public IBillCreditNotes BillCreditNotes { get; private set; } + + /// + /// BillPayments SubSDK. + /// + /// public IBillPayments BillPayments { get; private set; } + + /// + /// Bills SubSDK. + /// + /// public IBills Bills { get; private set; } + + /// + /// Suppliers SubSDK. + /// + /// public ISuppliers Suppliers { get; private set; } public AccountsPayable(SDKConfig config) diff --git a/lending/Codat/Lending/AccountsReceivable.cs b/lending/Codat/Lending/AccountsReceivable.cs index 2ee169e8a..f84d462eb 100644 --- a/lending/Codat/Lending/AccountsReceivable.cs +++ b/lending/Codat/Lending/AccountsReceivable.cs @@ -17,26 +17,60 @@ namespace Codat.Lending public interface IAccountsReceivable { public IInvoices Invoices { get; } + public ICreditNotes CreditNotes { get; } + public ICustomers Customers { get; } + public IDirectIncomes DirectIncomes { get; } + public IPayments Payments { get; } + public ICodatLendingReports Reports { get; } } public class AccountsReceivable: IAccountsReceivable { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// Invoices SubSDK. + /// + /// public IInvoices Invoices { get; private set; } + + /// + /// CreditNotes SubSDK. + /// + /// public ICreditNotes CreditNotes { get; private set; } + + /// + /// Customers SubSDK. + /// + /// public ICustomers Customers { get; private set; } + + /// + /// DirectIncomes SubSDK. + /// + /// public IDirectIncomes DirectIncomes { get; private set; } + + /// + /// Payments SubSDK. + /// + /// public IPayments Payments { get; private set; } + + /// + /// Reports SubSDK. + /// + /// public ICodatLendingReports Reports { get; private set; } public AccountsReceivable(SDKConfig config) diff --git a/lending/Codat/Lending/BalanceSheet.cs b/lending/Codat/Lending/BalanceSheet.cs index 726f68962..456650b6b 100644 --- a/lending/Codat/Lending/BalanceSheet.cs +++ b/lending/Codat/Lending/BalanceSheet.cs @@ -24,43 +24,80 @@ namespace Codat.Lending public interface IBalanceSheet { - /// - /// Get categorized balance sheet statement - /// + /// Get categorized balance sheet statement. + /// /// /// The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date.
///
/// Codat suggests a category for each account automatically, but you can change it to a more suitable one. ///
- /// - Task GetCategorizedAccountsAsync(GetCategorizedBalanceSheetStatementRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCategorizedAccountsAsync( + GetCategorizedBalanceSheetStatementRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get balance sheet - /// + /// Get balance sheet. + /// /// /// Gets the latest balance sheet for a company. /// - /// - Task GetAsync(GetAccountingBalanceSheetRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingBalanceSheetRequest request, + RetryConfig? retryConfig = null + ); } public class BalanceSheet: IBalanceSheet { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public BalanceSheet(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCategorizedAccountsAsync(GetCategorizedBalanceSheetStatementRequest request, RetryConfig? retryConfig = null) + /// + /// Get categorized balance sheet statement. + /// + /// + /// The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date.
+ ///
+ /// Codat suggests a category for each account automatically, but you can change it to a more suitable one. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCategorizedAccountsAsync( + GetCategorizedBalanceSheetStatementRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -120,7 +157,7 @@ public async Task GetCategorizedAcc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -225,7 +262,25 @@ public async Task GetCategorizedAcc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingBalanceSheetRequest request, RetryConfig? retryConfig = null) + + /// + /// Get balance sheet. + /// + /// + /// Gets the latest balance sheet for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingBalanceSheetRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -285,7 +340,7 @@ public async Task GetAsync(GetAccountingBalan httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -389,5 +444,6 @@ public async Task GetAsync(GetAccountingBalan throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/BankAccounts.cs b/lending/Codat/Lending/BankAccounts.cs index b55353c47..e3f348787 100644 --- a/lending/Codat/Lending/BankAccounts.cs +++ b/lending/Codat/Lending/BankAccounts.cs @@ -24,10 +24,9 @@ namespace Codat.Lending public interface IBankAccounts { - /// - /// Get create/update bank account model - /// + /// Get create/update bank account model. + /// /// /// The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a bank account for a given company and integration.
///
@@ -35,17 +34,26 @@ public interface IBankAccounts ///
/// **Integration-specific behavior**
///
- /// See the *response examples* for integration-specific indicative models.
- /// + /// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateUpdateModelAsync(GetCreateUpdateBankAccountsModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateUpdateModelAsync( + GetCreateUpdateBankAccountsModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create bank account - /// + /// Create bank account. + /// /// - /// The *Create bank account* endpoint creates a new bank account for a given company's connection.
+ /// The *Create bank account* endpoint creates a new bank account for a given company's connection.
///
/// Bank accounts are financial accounts maintained by a bank or other financial institution.
///
@@ -53,25 +61,57 @@ public interface IBankAccounts ///
/// Required data may vary by integration. To see what data to post, first call Get create/update bank account model. ///
- /// - Task CreateAsync(CreateBankAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateBankAccountRequest request, + RetryConfig? retryConfig = null + ); } public class BankAccounts: IBankAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public BankAccounts(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateUpdateModelAsync(GetCreateUpdateBankAccountsModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create/update bank account model. + /// + /// + /// The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a bank account for a given company and integration.
+ ///
+ /// Bank accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateUpdateModelAsync( + GetCreateUpdateBankAccountsModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -131,7 +171,7 @@ public async Task GetCreateUpdateModel httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -236,7 +276,31 @@ public async Task GetCreateUpdateModel throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateBankAccountRequest request, RetryConfig? retryConfig = null) + + /// + /// Create bank account. + /// + /// + /// The *Create bank account* endpoint creates a new bank account for a given company's connection.
+ ///
+ /// Bank accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update bank account model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateBankAccountRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -302,7 +366,7 @@ public async Task CreateAsync(CreateBankAccountReques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -406,5 +470,6 @@ public async Task CreateAsync(CreateBankAccountReques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/BankStatements.cs b/lending/Codat/Lending/BankStatements.cs index 1ee3da662..398a465fa 100644 --- a/lending/Codat/Lending/BankStatements.cs +++ b/lending/Codat/Lending/BankStatements.cs @@ -27,36 +27,55 @@ namespace Codat.Lending /// public interface IBankStatements { - /// - /// Get upload configuration - /// + /// Get upload configuration. + /// /// /// Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection.
///
/// With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.
///
- /// When you use the *Upload data* endpoint next, you must upload the data for the account you configured. + /// When you use the *Upload data* endpoint next, you must upload the data for the account you configured. ///
- /// - Task GetUploadConfigurationAsync(GetBankStatementUploadConfigurationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetUploadConfigurationAsync( + GetBankStatementUploadConfigurationRequest request, + RetryConfig? retryConfig = null + ); /// - /// Set upload configuration - /// + /// Set upload configuration. + /// /// /// Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection.
///
/// With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.
///
- /// Each data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. + /// Each data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. ///
- /// - Task SetUploadConfigurationAsync(SetBankStatementUploadConfigurationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task SetUploadConfigurationAsync( + SetBankStatementUploadConfigurationRequest request, + RetryConfig? retryConfig = null + ); /// - /// Start upload session - /// + /// Start upload session. + /// /// /// Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company.
///
@@ -64,30 +83,60 @@ public interface IBankStatements ///
/// You can only have one active session per data type at a time. You can complete or cancel a session using the *End upload session* endpoint. ///
- /// - Task StartUploadSessionAsync(StartBankStatementUploadSessionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task StartUploadSessionAsync( + StartBankStatementUploadSessionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Upload data - /// + /// Upload data. + /// /// /// During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session.
///
- /// Make sure you created configuration for the account using the *Set upload configuration* endpoint before attempting an upload. + /// Make sure you created configuration for the account using the *Set upload configuration* endpoint before attempting an upload. ///
- /// - Task UploadBankStatementDataAsync(UploadBankStatementDataRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UploadBankStatementDataAsync( + UploadBankStatementDataRequest request, + RetryConfig? retryConfig = null + ); /// - /// End upload session - /// + /// End upload session. + /// /// /// Use the *End upload session* endpoint to finalize a bank statement upload session. Include a `status` in the request body to indicate if you want to cancel the processing of the dataset or trigger the ingestion and enrichment of the data.
///
/// A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. ///
- /// - Task EndUploadSessionAsync(EndBankStatementUploadSessionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task EndUploadSessionAsync( + EndBankStatementUploadSessionRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -95,19 +144,39 @@ public interface IBankStatements /// public class BankStatements: IBankStatements { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public BankStatements(SDKConfig config) { SDKConfiguration = config; } - public async Task GetUploadConfigurationAsync(GetBankStatementUploadConfigurationRequest request, RetryConfig? retryConfig = null) + /// + /// Get upload configuration. + /// + /// + /// Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection.
+ ///
+ /// With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.
+ ///
+ /// When you use the *Upload data* endpoint next, you must upload the data for the account you configured. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetUploadConfigurationAsync( + GetBankStatementUploadConfigurationRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -167,7 +236,7 @@ public async Task GetUploadConfigur httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -272,7 +341,29 @@ public async Task GetUploadConfigur throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task SetUploadConfigurationAsync(SetBankStatementUploadConfigurationRequest request, RetryConfig? retryConfig = null) + + /// + /// Set upload configuration. + /// + /// + /// Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection.
+ ///
+ /// With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.
+ ///
+ /// Each data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task SetUploadConfigurationAsync( + SetBankStatementUploadConfigurationRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -338,7 +429,7 @@ public async Task SetUploadConfigur httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -443,7 +534,29 @@ public async Task SetUploadConfigur throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task StartUploadSessionAsync(StartBankStatementUploadSessionRequest request, RetryConfig? retryConfig = null) + + /// + /// Start upload session. + /// + /// + /// Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company.
+ ///
+ /// A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded.
+ ///
+ /// You can only have one active session per data type at a time. You can complete or cancel a session using the *End upload session* endpoint. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task StartUploadSessionAsync( + StartBankStatementUploadSessionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -509,7 +622,7 @@ public async Task StartUploadSessionAsy httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -614,7 +727,27 @@ public async Task StartUploadSessionAsy throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UploadBankStatementDataAsync(UploadBankStatementDataRequest request, RetryConfig? retryConfig = null) + + /// + /// Upload data. + /// + /// + /// During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session.
+ ///
+ /// Make sure you created configuration for the account using the *Set upload configuration* endpoint before attempting an upload. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UploadBankStatementDataAsync( + UploadBankStatementDataRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -680,7 +813,7 @@ public async Task UploadBankStatementDataAsync( httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -767,7 +900,27 @@ public async Task UploadBankStatementDataAsync( throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task EndUploadSessionAsync(EndBankStatementUploadSessionRequest request, RetryConfig? retryConfig = null) + + /// + /// End upload session. + /// + /// + /// Use the *End upload session* endpoint to finalize a bank statement upload session. Include a `status` in the request body to indicate if you want to cancel the processing of the dataset or trigger the ingestion and enrichment of the data.
+ ///
+ /// A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task EndUploadSessionAsync( + EndBankStatementUploadSessionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -833,7 +986,7 @@ public async Task EndUploadSessionAsync(E httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -919,5 +1072,6 @@ public async Task EndUploadSessionAsync(E throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/BankTransactions.cs b/lending/Codat/Lending/BankTransactions.cs index 15d210045..672375d99 100644 --- a/lending/Codat/Lending/BankTransactions.cs +++ b/lending/Codat/Lending/BankTransactions.cs @@ -24,54 +24,94 @@ namespace Codat.Lending public interface IBankTransactions { - /// - /// Get create bank account transactions model - /// + /// Get create bank account transactions model. + /// /// /// The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating bank account transactions for a given company and integration.
///
- /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
+ /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
///
/// **Integration-specific behavior**
///
/// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateModelAsync(GetCreateBankTransactionsModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreateBankTransactionsModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create bank account transactions - /// + /// Create bank account transactions. + /// /// - /// The *Create bank account transactions* endpoint creates new bank account transactions for a given company's connection.
+ /// The *Create bank account transactions* endpoint creates new bank account transactions for a given company's connection.
///
- /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
+ /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
///
/// **Integration-specific behavior**
///
- /// Required data may vary by integration. To see what data to post, first call Get create bank transaction model.
- /// + /// Required data may vary by integration. To see what data to post, first call Get create bank transaction model. ///
- /// - Task CreateAsync(CreateBankTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateBankTransactionsRequest request, + RetryConfig? retryConfig = null + ); } public class BankTransactions: IBankTransactions { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public BankTransactions(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateModelAsync(GetCreateBankTransactionsModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create bank account transactions model. + /// + /// + /// The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating bank account transactions for a given company and integration.
+ ///
+ /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreateBankTransactionsModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -131,7 +171,7 @@ public async Task GetCreateModelAsync(Ge httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -236,7 +276,31 @@ public async Task GetCreateModelAsync(Ge throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateBankTransactionsRequest request, RetryConfig? retryConfig = null) + + /// + /// Create bank account transactions. + /// + /// + /// The *Create bank account transactions* endpoint creates new bank account transactions for a given company's connection.
+ ///
+ /// Bank account transactions are records of money that has moved in and out of an SMB's bank account.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create bank transaction model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateBankTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -302,7 +366,7 @@ public async Task CreateAsync(CreateBankTransact httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -406,5 +470,6 @@ public async Task CreateAsync(CreateBankTransact throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Banking.cs b/lending/Codat/Lending/Banking.cs index d9aea9c62..b6e17d5ba 100644 --- a/lending/Codat/Lending/Banking.cs +++ b/lending/Codat/Lending/Banking.cs @@ -17,24 +17,52 @@ namespace Codat.Lending public interface IBanking { public ICategorizedStatement CategorizedStatement { get; } + public IAccountBalances AccountBalances { get; } + public ICodatLendingBankingAccounts Accounts { get; } + public ICodatLendingTransactions Transactions { get; } + public ITransactionCategories TransactionCategories { get; } } public class Banking: IBanking { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// CategorizedStatement SubSDK. + /// + /// public ICategorizedStatement CategorizedStatement { get; private set; } + + /// + /// AccountBalances SubSDK. + /// + /// public IAccountBalances AccountBalances { get; private set; } + + /// + /// Accounts SubSDK. + /// + /// public ICodatLendingBankingAccounts Accounts { get; private set; } + + /// + /// Transactions SubSDK. + /// + /// public ICodatLendingTransactions Transactions { get; private set; } + + /// + /// TransactionCategories SubSDK. + /// + /// public ITransactionCategories TransactionCategories { get; private set; } public Banking(SDKConfig config) diff --git a/lending/Codat/Lending/BillCreditNotes.cs b/lending/Codat/Lending/BillCreditNotes.cs index 3e13707de..d85dbc4b6 100644 --- a/lending/Codat/Lending/BillCreditNotes.cs +++ b/lending/Codat/Lending/BillCreditNotes.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IBillCreditNotes { - /// - /// List bill credit notes - /// + /// List bill credit notes. + /// /// - /// The *List bill credit notes* endpoint returns a list of bill credit notes for a given company's connection.
+ /// The *List bill credit notes* endpoint returns a list of bill credit notes for a given company's connection.
///
/// Bill credit notes are issued by a supplier for the purpose of recording credit.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingBillCreditNotesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingBillCreditNotesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get bill credit note - /// + /// Get bill credit note. + /// /// /// The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.
///
/// Bill credit notes are issued by a supplier for the purpose of recording credit.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingBillCreditNoteRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingBillCreditNoteRequest request, + RetryConfig? retryConfig = null + ); } public class BillCreditNotes: IBillCreditNotes { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public BillCreditNotes(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingBillCreditNotesRequest request, RetryConfig? retryConfig = null) + /// + /// List bill credit notes. + /// + /// + /// The *List bill credit notes* endpoint returns a list of bill credit notes for a given company's connection.
+ ///
+ /// Bill credit notes are issued by a supplier for the purpose of recording credit.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingBillCreditNotesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountin httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountin throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingBillCreditNoteRequest request, RetryConfig? retryConfig = null) + + /// + /// Get bill credit note. + /// + /// + /// The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.
+ ///
+ /// Bill credit notes are issued by a supplier for the purpose of recording credit.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingBillCreditNoteRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingBil httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingBil throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/BillPayments.cs b/lending/Codat/Lending/BillPayments.cs index 33585f9e7..80446e5ae 100644 --- a/lending/Codat/Lending/BillPayments.cs +++ b/lending/Codat/Lending/BillPayments.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IBillPayments { - /// - /// List bill payments - /// + /// List bill payments. + /// /// - /// The *List bill payments* endpoint returns a list of bill payments for a given company's connection.
+ /// The *List bill payments* endpoint returns a list of bill payments for a given company's connection.
///
/// Bill payments are an allocation of money within any customer accounts payable account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingBillPaymentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingBillPaymentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get bill payment - /// + /// Get bill payment. + /// /// /// The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.
///
/// Bill payments are an allocation of money within any customer accounts payable account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingBillPaymentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingBillPaymentRequest request, + RetryConfig? retryConfig = null + ); } public class BillPayments: IBillPayments { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public BillPayments(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingBillPaymentsRequest request, RetryConfig? retryConfig = null) + /// + /// List bill payments. + /// + /// + /// The *List bill payments* endpoint returns a list of bill payments for a given company's connection.
+ ///
+ /// Bill payments are an allocation of money within any customer accounts payable account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingBillPaymentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountingBi httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountingBi throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingBillPaymentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get bill payment. + /// + /// + /// The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.
+ ///
+ /// Bill payments are an allocation of money within any customer accounts payable account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingBillPaymentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingBillPa httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingBillPa throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Bills.cs b/lending/Codat/Lending/Bills.cs index 0cd108c02..235484273 100644 --- a/lending/Codat/Lending/Bills.cs +++ b/lending/Codat/Lending/Bills.cs @@ -24,93 +24,163 @@ namespace Codat.Lending public interface IBills { - /// - /// List bills - /// + /// List bills. + /// /// - /// The *List bills* endpoint returns a list of bills for a given company's connection.
+ /// The *List bills* endpoint returns a list of bills for a given company's connection.
///
- /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
///
/// Before using this endpoint, you must have retrieved data for the company.
///
/// ### Tips and traps
///
- /// To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.
- /// + /// To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. ///
- /// - Task ListAsync(ListAccountingBillsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingBillsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get bill - /// + /// Get bill. + /// /// /// The *Get bill* endpoint returns a single bill for a given billId.
///
- /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
///
/// Before using this endpoint, you must have retrieved data for the company.
///
/// ### Tips and traps
///
- /// To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.
- /// + /// To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. ///
- /// - Task GetAsync(GetAccountingBillRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingBillRequest request, + RetryConfig? retryConfig = null + ); /// - /// List bill attachments - /// + /// List bill attachments. + /// /// /// The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.
///
- /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
- /// + /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. ///
- /// - Task ListAttachmentsAsync(ListAccountingBillAttachmentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAttachmentsAsync( + ListAccountingBillAttachmentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get bill attachment - /// + /// Get bill attachment. + /// /// /// The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.
///
- /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. ///
- /// - Task GetAttachmentAsync(GetAccountingBillAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAttachmentAsync( + GetAccountingBillAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download bill attachment - /// + /// Download bill attachment. + /// /// /// The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.
///
- /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. ///
- /// - Task DownloadAttachmentAsync(DownloadAccountingBillAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAttachmentAsync( + DownloadAccountingBillAttachmentRequest request, + RetryConfig? retryConfig = null + ); } public class Bills: IBills { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Bills(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingBillsRequest request, RetryConfig? retryConfig = null) + /// + /// List bills. + /// + /// + /// The *List bills* endpoint returns a list of bills for a given company's connection.
+ ///
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ ///
+ /// ### Tips and traps
+ ///
+ /// To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingBillsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -170,7 +240,7 @@ public async Task ListAsync(ListAccountingBillsRequ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -275,7 +345,33 @@ public async Task ListAsync(ListAccountingBillsRequ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingBillRequest request, RetryConfig? retryConfig = null) + + /// + /// Get bill. + /// + /// + /// The *Get bill* endpoint returns a single bill for a given billId.
+ ///
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ ///
+ /// ### Tips and traps
+ ///
+ /// To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingBillRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -335,7 +431,7 @@ public async Task GetAsync(GetAccountingBillRequest r httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -440,7 +536,27 @@ public async Task GetAsync(GetAccountingBillRequest r throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAttachmentsAsync(ListAccountingBillAttachmentsRequest request, RetryConfig? retryConfig = null) + + /// + /// List bill attachments. + /// + /// + /// The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.
+ ///
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAttachmentsAsync( + ListAccountingBillAttachmentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -500,7 +616,7 @@ public async Task ListAttachmentsAsync(Li httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -605,7 +721,27 @@ public async Task ListAttachmentsAsync(Li throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAttachmentAsync(GetAccountingBillAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get bill attachment. + /// + /// + /// The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.
+ ///
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAttachmentAsync( + GetAccountingBillAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -665,7 +801,7 @@ public async Task GetAttachmentAsync(GetAcc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -770,7 +906,27 @@ public async Task GetAttachmentAsync(GetAcc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAttachmentAsync(DownloadAccountingBillAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Download bill attachment. + /// + /// + /// The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.
+ ///
+ /// Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAttachmentAsync( + DownloadAccountingBillAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -830,7 +986,7 @@ public async Task DownloadAttachmentAs httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -923,5 +1079,6 @@ public async Task DownloadAttachmentAs throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CashFlow.cs b/lending/Codat/Lending/CashFlow.cs index 493b7abe5..e43b8e3b5 100644 --- a/lending/Codat/Lending/CashFlow.cs +++ b/lending/Codat/Lending/CashFlow.cs @@ -24,32 +24,57 @@ namespace Codat.Lending public interface ICashFlow { - /// - /// Get cash flow statement - /// + /// Get cash flow statement. + /// /// /// Gets the latest cash flow statement for a company. /// - /// - Task GetAsync(GetAccountingCashFlowStatementRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingCashFlowStatementRequest request, + RetryConfig? retryConfig = null + ); } public class CashFlow: ICashFlow { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CashFlow(SDKConfig config) { SDKConfiguration = config; } - public async Task GetAsync(GetAccountingCashFlowStatementRequest request, RetryConfig? retryConfig = null) + /// + /// Get cash flow statement. + /// + /// + /// Gets the latest cash flow statement for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingCashFlowStatementRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -109,7 +134,7 @@ public async Task GetAsync(GetAccounting httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -213,5 +238,6 @@ public async Task GetAsync(GetAccounting throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CategorizedStatement.cs b/lending/Codat/Lending/CategorizedStatement.cs index 2c3736e65..b4be1965e 100644 --- a/lending/Codat/Lending/CategorizedStatement.cs +++ b/lending/Codat/Lending/CategorizedStatement.cs @@ -24,36 +24,65 @@ namespace Codat.Lending public interface ICategorizedStatement { - /// - /// Get categorized bank statement - /// + /// Get categorized bank statement. + /// /// /// > **Categorization engine**
/// >
/// > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.
///
- /// The _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + /// The _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. ///
- /// - Task GetAsync(GetCategorizedBankStatementRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCategorizedBankStatementRequest request, + RetryConfig? retryConfig = null + ); } public class CategorizedStatement: ICategorizedStatement { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CategorizedStatement(SDKConfig config) { SDKConfiguration = config; } - public async Task GetAsync(GetCategorizedBankStatementRequest request, RetryConfig? retryConfig = null) + /// + /// Get categorized bank statement. + /// + /// + /// > **Categorization engine**
+ /// >
+ /// > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.
+ ///
+ /// The _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCategorizedBankStatementRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -113,7 +142,7 @@ public async Task GetAsync(GetCategorizedBa httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -217,5 +246,6 @@ public async Task GetAsync(GetCategorizedBa throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Codat.Lending.csproj b/lending/Codat/Lending/Codat.Lending.csproj index 1d6da12ab..c88d46496 100644 --- a/lending/Codat/Lending/Codat.Lending.csproj +++ b/lending/Codat/Lending/Codat.Lending.csproj @@ -3,7 +3,7 @@ true Codat.Lending - 10.0.0 + 10.0.1 net8.0 Codat Copyright (c) Codat 2026 diff --git a/lending/Codat/Lending/CodatLending.cs b/lending/Codat/Lending/CodatLending.cs index 9d53300bd..c91360b0c 100644 --- a/lending/Codat/Lending/CodatLending.cs +++ b/lending/Codat/Lending/CodatLending.cs @@ -19,22 +19,19 @@ namespace Codat.Lending using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; - /// - /// Lending: Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.
- /// - /// + /// Lending: Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.
///
/// The Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers.
///
- /// Explore solution | See OpenAPI spec
+ /// Explore solution | See OpenAPI spec ///
/// <!-- Start Codat Tags Table -->
/// ## Endpoints
///
/// | Endpoints | Description |
/// | :- |:- |
- /// | Companies | Create and manage your SMB users' companies. |
+ /// | Companies | Create and manage your SMB users' companies. |
/// | Connections | Create new and manage existing data connections for a company. |
/// | Bank statements | Retrieve banking data from linked bank accounts. |
/// | Sales | Retrieve standardized sales data from a linked commerce software. |
@@ -50,13 +47,11 @@ namespace Codat.Lending /// | File upload | Endpoints to manage uploaded files. |
/// | Loan writeback | Implement the loan writeback procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. |
/// <!-- End Codat Tags Table --> - ///
///
public interface ICodatLending { - /// - /// Create and manage your SMB users' companies. + /// Create and manage your SMB users' companies. /// public ICompanies Companies { get; } @@ -64,27 +59,34 @@ public interface ICodatLending /// Create new and manage existing data connections for a company. /// public IConnections Connections { get; } + public IManageData ManageData { get; } /// /// Match mutable accounting data with immutable banking data to increase confidence in financial data. /// public IDataIntegrity DataIntegrity { get; } + public IFinancialStatements FinancialStatements { get; } + public IBanking Banking { get; } + public IAccountsReceivable AccountsReceivable { get; } /// /// Debt and other liabilities. /// public ILiabilities Liabilities { get; } + public ISales Sales { get; } /// /// Download reports in Excel format. /// public IExcelReports ExcelReports { get; } + public ITransactions Transactions { get; } + public IAccountsPayable AccountsPayable { get; } /// @@ -101,6 +103,7 @@ public interface ICodatLending /// Endpoints to manage uploaded files. /// public IFileUpload FileUpload { get; } + public ILoanWriteback LoanWriteback { get; } /// @@ -114,22 +117,19 @@ public interface ICodatLending public IManageReports ManageReports { get; } } - /// - /// Lending: Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.
- /// - /// + /// Lending: Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.
///
/// The Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers.
///
- /// Explore solution | See OpenAPI spec
+ /// Explore solution | See OpenAPI spec ///
/// <!-- Start Codat Tags Table -->
/// ## Endpoints
///
/// | Endpoints | Description |
/// | :- |:- |
- /// | Companies | Create and manage your SMB users' companies. |
+ /// | Companies | Create and manage your SMB users' companies. |
/// | Connections | Create new and manage existing data connections for a company. |
/// | Bank statements | Retrieve banking data from linked bank accounts. |
/// | Sales | Retrieve standardized sales data from a linked commerce software. |
@@ -145,35 +145,90 @@ public interface ICodatLending /// | File upload | Endpoints to manage uploaded files. |
/// | Loan writeback | Implement the loan writeback procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. |
/// <!-- End Codat Tags Table --> - ///
///
public class CodatLending: ICodatLending { + /// + /// The main SDK Configuration. + /// public SDKConfig SDKConfiguration { get; private set; } - - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// The Companies sub-SDK. + /// public ICompanies Companies { get; private set; } + /// + /// The Connections sub-SDK. + /// public IConnections Connections { get; private set; } + /// + /// The ManageData sub-SDK. + /// public IManageData ManageData { get; private set; } + /// + /// The DataIntegrity sub-SDK. + /// public IDataIntegrity DataIntegrity { get; private set; } + /// + /// The FinancialStatements sub-SDK. + /// public IFinancialStatements FinancialStatements { get; private set; } + /// + /// The Banking sub-SDK. + /// public IBanking Banking { get; private set; } + /// + /// The AccountsReceivable sub-SDK. + /// public IAccountsReceivable AccountsReceivable { get; private set; } + /// + /// The Liabilities sub-SDK. + /// public ILiabilities Liabilities { get; private set; } + /// + /// The Sales sub-SDK. + /// public ISales Sales { get; private set; } + /// + /// The ExcelReports sub-SDK. + /// public IExcelReports ExcelReports { get; private set; } + /// + /// The Transactions sub-SDK. + /// public ITransactions Transactions { get; private set; } + /// + /// The AccountsPayable sub-SDK. + /// public IAccountsPayable AccountsPayable { get; private set; } + /// + /// The CompanyInfo sub-SDK. + /// public ICompanyInfo CompanyInfo { get; private set; } + /// + /// The AccountingBankData sub-SDK. + /// public IAccountingBankData AccountingBankData { get; private set; } + /// + /// The FileUpload sub-SDK. + /// public IFileUpload FileUpload { get; private set; } + /// + /// The LoanWriteback sub-SDK. + /// public ILoanWriteback LoanWriteback { get; private set; } + /// + /// The BankStatements sub-SDK. + /// public IBankStatements BankStatements { get; private set; } + /// + /// The ManageReports sub-SDK. + /// public IManageReports ManageReports { get; private set; } + /// + /// Initializes a new instance of the SDK based on a configuration object. + /// + /// The SDK configuration object. public CodatLending(SDKConfig config) { SDKConfiguration = config; @@ -226,14 +281,23 @@ public CodatLending(SDKConfig config) /// A dictionary of parameters to use for templating the serverUrl. Only used when serverUrl is provided. /// A custom HTTP client implementation to use for making API requests. If not provided, the default SpeakeasyHttpClient will be used. /// Configuration for retry behavior when API requests fail. Defines retry strategies, backoff policies, and maximum retry attempts. - /// Thrown when the serverIndex is out of range (less than 0 or greater than or equal to the server list length). - public CodatLending(string? authHeader = null, Func? authHeaderSource = null, int? serverIndex = null, string? serverUrl = null, Dictionary? urlParams = null, ISpeakeasyHttpClient? client = null, RetryConfig? retryConfig = null) + /// Invalid value provided for : must be between 0 (inclusive) and 1 (exclusive). + /// None of and were provided. + public CodatLending( + string? authHeader = null, + Func? authHeaderSource = null, + int? serverIndex = null, + string? serverUrl = null, + Dictionary? urlParams = null, + ISpeakeasyHttpClient? client = null, + RetryConfig? retryConfig = null + ) { if (serverIndex != null) { if (serverIndex.Value < 0 || serverIndex.Value >= SDKConfig.ServerList.Length) { - throw new Exception($"Invalid server index {serverIndex.Value}"); + throw new ArgumentOutOfRangeException($"Invalid server index {serverIndex}: must be between 0 (inclusive) and {SDKConfig.ServerList.Length} (exclusive)." ); } } @@ -256,7 +320,7 @@ public CodatLending(string? authHeader = null, Func? authHeaderSource = } else { - throw new Exception("authHeader and authHeaderSource cannot both be null"); + throw new ArgumentException("authHeader and authHeaderSource cannot both be null"); } SDKConfiguration = new SDKConfig(client) @@ -319,22 +383,31 @@ private void InitHooks() SDKConfiguration = config; } + /// + /// Builder class for constructing an instance of the SDK. + /// public class SDKBuilder { private SDKConfig _sdkConfig = new SDKConfig(client: new SpeakeasyHttpClient()); public SDKBuilder() { } + /// + /// Overrides the default server by index. + /// public SDKBuilder WithServerIndex(int serverIndex) { if (serverIndex < 0 || serverIndex >= SDKConfig.ServerList.Length) { - throw new Exception($"Invalid server index {serverIndex}"); + throw new ArgumentOutOfRangeException($"Invalid server index {serverIndex}: must be between 0 (inclusive) and {SDKConfig.ServerList.Length} (exclusive)." ); } _sdkConfig.ServerIndex = serverIndex; return this; } + /// + /// Overrides the default server URL for the SDK. + /// public SDKBuilder WithServerUrl(string serverUrl, Dictionary? serverVariables = null) { if (serverVariables != null) @@ -345,34 +418,49 @@ public SDKBuilder WithServerUrl(string serverUrl, Dictionary? se return this; } + /// + /// Sets the authHeaderSource security parameter for the SDK. + /// public SDKBuilder WithAuthHeaderSource(Func authHeaderSource) { _sdkConfig.SecuritySource = () => new Codat.Lending.Models.Components.Security() { AuthHeader = authHeaderSource() }; return this; } + /// + /// Sets the authHeader security parameter for the SDK. + /// public SDKBuilder WithAuthHeader(string authHeader) { _sdkConfig.SecuritySource = () => new Codat.Lending.Models.Components.Security() { AuthHeader = authHeader }; return this; } + /// + /// Sets a custom HTTP client to be used by the SDK. + /// public SDKBuilder WithClient(ISpeakeasyHttpClient client) { _sdkConfig.Client = client; return this; } + /// + /// Sets the retry configuration for the SDK. + /// public SDKBuilder WithRetryConfig(RetryConfig retryConfig) { _sdkConfig.RetryConfig = retryConfig; return this; } + /// + /// Builds and returns the SDK instance. + /// public CodatLending Build() { if (_sdkConfig.SecuritySource == null) { - throw new Exception("securitySource cannot be null. One of `AuthHeader` or `authHeaderSource` needs to be defined."); + throw new ArgumentException("securitySource cannot be null. One of `AuthHeader` or `authHeaderSource` needs to be defined."); } return new CodatLending(_sdkConfig); } diff --git a/lending/Codat/Lending/CodatLendingAccounts.cs b/lending/Codat/Lending/CodatLendingAccounts.cs index 76f84a412..bb5ca19a1 100644 --- a/lending/Codat/Lending/CodatLendingAccounts.cs +++ b/lending/Codat/Lending/CodatLendingAccounts.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ICodatLendingAccounts { - /// - /// List bank accounts - /// + /// List bank accounts. + /// /// - /// The *List bank accounts* endpoint returns a list of bank accounts for a given company's connection.
+ /// The *List bank accounts* endpoint returns a list of bank accounts for a given company's connection.
///
/// Bank accounts are financial accounts maintained by a bank or other financial institution.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- ///
- Task ListAsync(ListAccountingBankAccountsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingBankAccountsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get bank account - /// + /// Get bank account. + /// /// /// The *Get bank account* endpoint returns a single account for a given accountId.
///
/// Bank accounts are financial accounts maintained by a bank or other financial institution.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingBankAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingBankAccountRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingAccounts: ICodatLendingAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingAccounts(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingBankAccountsRequest request, RetryConfig? retryConfig = null) + /// + /// List bank accounts. + /// + /// + /// The *List bank accounts* endpoint returns a list of bank accounts for a given company's connection.
+ ///
+ /// Bank accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingBankAccountsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountingBa httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountingBa throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingBankAccountRequest request, RetryConfig? retryConfig = null) + + /// + /// Get bank account. + /// + /// + /// The *Get bank account* endpoint returns a single account for a given accountId.
+ ///
+ /// Bank accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingBankAccountRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingBankAc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingBankAc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingBankingAccounts.cs b/lending/Codat/Lending/CodatLendingBankingAccounts.cs index 39e117409..d8b41658e 100644 --- a/lending/Codat/Lending/CodatLendingBankingAccounts.cs +++ b/lending/Codat/Lending/CodatLendingBankingAccounts.cs @@ -24,24 +24,32 @@ namespace Codat.Lending public interface ICodatLendingBankingAccounts { - /// - /// List accounts - /// + /// List accounts. + /// /// - /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
+ /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
///
/// Accounts are financial accounts maintained by a bank or other financial institution.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListBankingAccountsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListBankingAccountsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get account - /// + /// Get account. + /// /// /// The *Get account* endpoint returns a single account for a given accountId.
///
@@ -49,25 +57,55 @@ public interface ICodatLendingBankingAccounts ///
/// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetBankingAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetBankingAccountRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingBankingAccounts: ICodatLendingBankingAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingBankingAccounts(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListBankingAccountsRequest request, RetryConfig? retryConfig = null) + /// + /// List accounts. + /// + /// + /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
+ ///
+ /// Accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListBankingAccountsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -127,7 +165,7 @@ public async Task ListAsync(ListBankingAccountsRequ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -232,7 +270,29 @@ public async Task ListAsync(ListBankingAccountsRequ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetBankingAccountRequest request, RetryConfig? retryConfig = null) + + /// + /// Get account. + /// + /// + /// The *Get account* endpoint returns a single account for a given accountId.
+ ///
+ /// Accounts are financial accounts maintained by a bank or other financial institution.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetBankingAccountRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -292,7 +352,7 @@ public async Task GetAsync(GetBankingAccountRequest r httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -396,5 +456,6 @@ public async Task GetAsync(GetBankingAccountRequest r throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingCustomers.cs b/lending/Codat/Lending/CodatLendingCustomers.cs index 812243295..c10743767 100644 --- a/lending/Codat/Lending/CodatLendingCustomers.cs +++ b/lending/Codat/Lending/CodatLendingCustomers.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ICodatLendingCustomers { - /// - /// List customers - /// + /// List customers. + /// /// - /// The *List customers* endpoint returns a list of customers for a given company's connection.
+ /// The *List customers* endpoint returns a list of customers for a given company's connection.
///
/// Customers are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommerceCustomersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceCustomersRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get customer - /// + /// Get customer. + /// /// /// The *Get customer* endpoint returns a single customer for a given customerId.
///
/// Customers are people or organizations that place orders, make payments and receive goods and/or services from the SMB.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommerceCustomerRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommerceCustomerRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingCustomers: ICodatLendingCustomers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingCustomers(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceCustomersRequest request, RetryConfig? retryConfig = null) + /// + /// List customers. + /// + /// + /// The *List customers* endpoint returns a list of customers for a given company's connection.
+ ///
+ /// Customers are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceCustomersRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommerceCustomers httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommerceCustomers throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceCustomerRequest request, RetryConfig? retryConfig = null) + + /// + /// Get customer. + /// + /// + /// The *Get customer* endpoint returns a single customer for a given customerId.
+ ///
+ /// Customers are people or organizations that place orders, make payments and receive goods and/or services from the SMB.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceCustomerRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommerceCustomerReque httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommerceCustomerReque throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingDirectCosts.cs b/lending/Codat/Lending/CodatLendingDirectCosts.cs index ad23f4e93..77998db81 100644 --- a/lending/Codat/Lending/CodatLendingDirectCosts.cs +++ b/lending/Codat/Lending/CodatLendingDirectCosts.cs @@ -24,54 +24,94 @@ namespace Codat.Lending public interface ICodatLendingDirectCosts { - /// - /// Get create direct cost model - /// + /// Get create direct cost model. + /// /// /// The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a direct cost for a given company and integration.
///
- /// Direct costs are business expenses that don't impact Accounts Payable.
+ /// Direct costs are business expenses that don't impact Accounts Payable.
///
/// **Integration-specific behavior**
///
- /// See the *response examples* for integration-specific indicative models.
- /// + /// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateModelAsync(GetCreateDirectCostsModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreateDirectCostsModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create direct cost - /// + /// Create direct cost. + /// /// - /// The *Create direct cost* endpoint creates a new direct cost for a given company's connection.
+ /// The *Create direct cost* endpoint creates a new direct cost for a given company's connection.
///
- /// Direct costs are business expenses that don't impact Accounts Payable.
+ /// Direct costs are business expenses that don't impact Accounts Payable.
///
/// **Integration-specific behavior**
///
/// Required data may vary by integration. To see what data to post, first call Get create direct cost model. ///
- /// - Task CreateAsync(CreateDirectCostRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateDirectCostRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingDirectCosts: ICodatLendingDirectCosts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingDirectCosts(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateModelAsync(GetCreateDirectCostsModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create direct cost model. + /// + /// + /// The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a direct cost for a given company and integration.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreateDirectCostsModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -131,7 +171,7 @@ public async Task GetCreateModelAsync(GetCrea httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -236,7 +276,31 @@ public async Task GetCreateModelAsync(GetCrea throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateDirectCostRequest request, RetryConfig? retryConfig = null) + + /// + /// Create direct cost. + /// + /// + /// The *Create direct cost* endpoint creates a new direct cost for a given company's connection.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create direct cost model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateDirectCostRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -302,7 +366,7 @@ public async Task CreateAsync(CreateDirectCostRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -406,5 +470,6 @@ public async Task CreateAsync(CreateDirectCostRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs b/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs index d518deb6c..2ee069d7c 100644 --- a/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs +++ b/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs @@ -24,10 +24,9 @@ namespace Codat.Lending public interface ICodatLendingLoanWritebackAccounts { - /// - /// Get create account model - /// + /// Get create account model. + /// /// /// The *Get create account model* endpoint returns the expected data for the request payload when creating an account for a given company and integration.
///
@@ -37,14 +36,24 @@ public interface ICodatLendingLoanWritebackAccounts ///
/// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateModelAsync(GetCreateChartOfAccountsModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreateChartOfAccountsModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create account - /// + /// Create account. + /// /// - /// The *Create account* endpoint creates a new account for a given company's connection.
+ /// The *Create account* endpoint creates a new account for a given company's connection.
///
/// Accounts are the categories a business uses to record accounting transactions.
///
@@ -52,25 +61,54 @@ public interface ICodatLendingLoanWritebackAccounts ///
/// Required data may vary by integration. To see what data to post, first call Get create account model. ///
- /// - Task CreateAsync(CreateAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync(CreateAccountRequest request, RetryConfig? retryConfig = null); } public class CodatLendingLoanWritebackAccounts: ICodatLendingLoanWritebackAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingLoanWritebackAccounts(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateModelAsync(GetCreateChartOfAccountsModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create account model. + /// + /// + /// The *Get create account model* endpoint returns the expected data for the request payload when creating an account for a given company and integration.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreateChartOfAccountsModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -130,7 +168,7 @@ public async Task GetCreateModelAsync(Get httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -235,7 +273,31 @@ public async Task GetCreateModelAsync(Get throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateAccountRequest request, RetryConfig? retryConfig = null) + + /// + /// Create account. + /// + /// + /// The *Create account* endpoint creates a new account for a given company's connection.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create account model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateAccountRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -301,7 +363,7 @@ public async Task CreateAsync(CreateAccountRequest reques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -405,5 +467,6 @@ public async Task CreateAsync(CreateAccountRequest reques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs b/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs index eaca91432..d920ee12b 100644 --- a/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs +++ b/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs @@ -24,10 +24,9 @@ namespace Codat.Lending public interface ICodatLendingLoanWritebackPayments { - /// - /// Get create payment model - /// + /// Get create payment model. + /// /// /// The *Get create payment model* endpoint returns the expected data for the request payload when creating a payment for a given company and integration.
///
@@ -37,14 +36,24 @@ public interface ICodatLendingLoanWritebackPayments ///
/// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateModelAsync(GetCreatePaymentModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreatePaymentModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create payment - /// + /// Create payment. + /// /// - /// The *Create payment* endpoint creates a new payment for a given company's connection.
+ /// The *Create payment* endpoint creates a new payment for a given company's connection.
///
/// Payments represent an allocation of money within any customer accounts receivable account.
///
@@ -52,25 +61,54 @@ public interface ICodatLendingLoanWritebackPayments ///
/// Required data may vary by integration. To see what data to post, first call Get create payment model. ///
- /// - Task CreateAsync(CreatePaymentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync(CreatePaymentRequest request, RetryConfig? retryConfig = null); } public class CodatLendingLoanWritebackPayments: ICodatLendingLoanWritebackPayments { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingLoanWritebackPayments(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateModelAsync(GetCreatePaymentModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create payment model. + /// + /// + /// The *Get create payment model* endpoint returns the expected data for the request payload when creating a payment for a given company and integration.
+ ///
+ /// Payments represent an allocation of money within any customer accounts receivable account.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreatePaymentModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -130,7 +168,7 @@ public async Task GetCreateModelAsync(GetCreatePa httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -235,7 +273,31 @@ public async Task GetCreateModelAsync(GetCreatePa throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreatePaymentRequest request, RetryConfig? retryConfig = null) + + /// + /// Create payment. + /// + /// + /// The *Create payment* endpoint creates a new payment for a given company's connection.
+ ///
+ /// Payments represent an allocation of money within any customer accounts receivable account.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create payment model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreatePaymentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -301,7 +363,7 @@ public async Task CreateAsync(CreatePaymentRequest reques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -405,5 +467,6 @@ public async Task CreateAsync(CreatePaymentRequest reques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingPayments.cs b/lending/Codat/Lending/CodatLendingPayments.cs index 9535ec50f..93480b4bb 100644 --- a/lending/Codat/Lending/CodatLendingPayments.cs +++ b/lending/Codat/Lending/CodatLendingPayments.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ICodatLendingPayments { - /// - /// List payments - /// + /// List payments. + /// /// - /// The *List payments* endpoint returns a list of payments for a given company's connection.
+ /// The *List payments* endpoint returns a list of payments for a given company's connection.
///
/// Payments contain details of all payments made by customers to the company.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommercePaymentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommercePaymentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get payment - /// + /// Get payment. + /// /// /// The *Get payment* endpoint returns a single payment for a given paymentId.
///
/// Payments contain details of all payments made by customers to the company.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommercePaymentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommercePaymentRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingPayments: ICodatLendingPayments { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingPayments(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommercePaymentsRequest request, RetryConfig? retryConfig = null) + /// + /// List payments. + /// + /// + /// The *List payments* endpoint returns a list of payments for a given company's connection.
+ ///
+ /// Payments contain details of all payments made by customers to the company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommercePaymentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommercePaymentsRe httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommercePaymentsRe throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommercePaymentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get payment. + /// + /// + /// The *Get payment* endpoint returns a single payment for a given paymentId.
+ ///
+ /// Payments contain details of all payments made by customers to the company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommercePaymentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommercePaymentRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommercePaymentRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingReports.cs b/lending/Codat/Lending/CodatLendingReports.cs index d08c38c7c..4b242d042 100644 --- a/lending/Codat/Lending/CodatLendingReports.cs +++ b/lending/Codat/Lending/CodatLendingReports.cs @@ -24,59 +24,114 @@ namespace Codat.Lending public interface ICodatLendingReports { - /// - /// Aged debtors report available - /// + /// Aged debtors report available. + /// /// /// Indicates whether the aged debtors report is available for the company. /// - /// - Task IsAgedDebtorsAvailableAsync(IsAgedDebtorsReportAvailableRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task IsAgedDebtorsAvailableAsync( + IsAgedDebtorsReportAvailableRequest request, + RetryConfig? retryConfig = null + ); /// - /// Aged debtors report - /// + /// Aged debtors report. + /// /// /// Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. /// - /// - Task GetAgedDebtorsAsync(GetAccountingAgedDebtorsReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAgedDebtorsAsync( + GetAccountingAgedDebtorsReportRequest request, + RetryConfig? retryConfig = null + ); /// - /// Aged creditors report available - /// + /// Aged creditors report available. + /// /// /// Indicates whether the aged creditor report is available for the company. /// - /// - Task IsAgedCreditorsAvailableAsync(IsAgedCreditorsReportAvailableRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task IsAgedCreditorsAvailableAsync( + IsAgedCreditorsReportAvailableRequest request, + RetryConfig? retryConfig = null + ); /// - /// Aged creditors report - /// + /// Aged creditors report. + /// /// /// Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. /// - /// - Task GetAgedCreditorsAsync(GetAccountingAgedCreditorsReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAgedCreditorsAsync( + GetAccountingAgedCreditorsReportRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingReports: ICodatLendingReports { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingReports(SDKConfig config) { SDKConfiguration = config; } - public async Task IsAgedDebtorsAvailableAsync(IsAgedDebtorsReportAvailableRequest request, RetryConfig? retryConfig = null) + /// + /// Aged debtors report available. + /// + /// + /// Indicates whether the aged debtors report is available for the company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task IsAgedDebtorsAvailableAsync( + IsAgedDebtorsReportAvailableRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -136,7 +191,7 @@ public async Task IsAgedDebtorsAvailableAs httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -241,7 +296,25 @@ public async Task IsAgedDebtorsAvailableAs throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAgedDebtorsAsync(GetAccountingAgedDebtorsReportRequest request, RetryConfig? retryConfig = null) + + /// + /// Aged debtors report. + /// + /// + /// Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAgedDebtorsAsync( + GetAccountingAgedDebtorsReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -301,7 +374,7 @@ public async Task GetAgedDebtorsAsync(Ge httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -406,7 +479,25 @@ public async Task GetAgedDebtorsAsync(Ge throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task IsAgedCreditorsAvailableAsync(IsAgedCreditorsReportAvailableRequest request, RetryConfig? retryConfig = null) + + /// + /// Aged creditors report available. + /// + /// + /// Indicates whether the aged creditor report is available for the company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task IsAgedCreditorsAvailableAsync( + IsAgedCreditorsReportAvailableRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -466,7 +557,7 @@ public async Task IsAgedCreditorsAvailab httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -571,7 +662,25 @@ public async Task IsAgedCreditorsAvailab throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAgedCreditorsAsync(GetAccountingAgedCreditorsReportRequest request, RetryConfig? retryConfig = null) + + /// + /// Aged creditors report. + /// + /// + /// Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAgedCreditorsAsync( + GetAccountingAgedCreditorsReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -631,7 +740,7 @@ public async Task GetAgedCreditorsAsyn httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -735,5 +844,6 @@ public async Task GetAgedCreditorsAsyn throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingSalesTransactions.cs b/lending/Codat/Lending/CodatLendingSalesTransactions.cs index cb4492033..79c5c493b 100644 --- a/lending/Codat/Lending/CodatLendingSalesTransactions.cs +++ b/lending/Codat/Lending/CodatLendingSalesTransactions.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ICodatLendingSalesTransactions { - /// - /// List transactions - /// + /// List transactions. + /// /// - /// The *List transactions* endpoint returns a list of transactions for a given company's connection.
+ /// The *List transactions* endpoint returns a list of transactions for a given company's connection.
///
/// Transactions detail all financial affairs recorded in the commerce or point of sale system.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommerceTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceTransactionsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get transaction - /// + /// Get transaction. + /// /// /// The *Get transaction* endpoint returns a single transaction for a given transactionId.
///
/// Transactions detail all financial affairs recorded in the commerce or point of sale system.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommerceTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommerceTransactionRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingSalesTransactions: ICodatLendingSalesTransactions { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingSalesTransactions(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceTransactionsRequest request, RetryConfig? retryConfig = null) + /// + /// List transactions. + /// + /// + /// The *List transactions* endpoint returns a list of transactions for a given company's connection.
+ ///
+ /// Transactions detail all financial affairs recorded in the commerce or point of sale system.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommerceTransa httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommerceTransa throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceTransactionRequest request, RetryConfig? retryConfig = null) + + /// + /// Get transaction. + /// + /// + /// The *Get transaction* endpoint returns a single transaction for a given transactionId.
+ ///
+ /// Transactions detail all financial affairs recorded in the commerce or point of sale system.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceTransactionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommerceTransactio httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommerceTransactio throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingSuppliers.cs b/lending/Codat/Lending/CodatLendingSuppliers.cs index 5101d3863..38888f780 100644 --- a/lending/Codat/Lending/CodatLendingSuppliers.cs +++ b/lending/Codat/Lending/CodatLendingSuppliers.cs @@ -24,10 +24,9 @@ namespace Codat.Lending public interface ICodatLendingSuppliers { - /// - /// Get create/update supplier model - /// + /// Get create/update supplier model. + /// /// /// The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a supplier for a given company and integration.
///
@@ -35,44 +34,81 @@ public interface ICodatLendingSuppliers ///
/// **Integration-specific behavior**
///
- /// See the *response examples* for integration-specific indicative models.
- /// + /// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateUpdateModelAsync(GetCreateUpdateSuppliersModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateUpdateModelAsync( + GetCreateUpdateSuppliersModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create supplier - /// + /// Create supplier. + /// /// - /// The *Create supplier* endpoint creates a new supplier for a given company's connection.
+ /// The *Create supplier* endpoint creates a new supplier for a given company's connection.
///
/// Suppliers are people or organizations that provide something, such as a product or service.
///
/// **Integration-specific behavior**
///
- /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model.
- /// + /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model. ///
- /// - Task CreateAsync(CreateSupplierRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync(CreateSupplierRequest request, RetryConfig? retryConfig = null); } public class CodatLendingSuppliers: ICodatLendingSuppliers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingSuppliers(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateUpdateModelAsync(GetCreateUpdateSuppliersModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create/update supplier model. + /// + /// + /// The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a supplier for a given company and integration.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateUpdateModelAsync( + GetCreateUpdateSuppliersModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -132,7 +168,7 @@ public async Task GetCreateUpdateModelAsy httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -237,7 +273,31 @@ public async Task GetCreateUpdateModelAsy throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateSupplierRequest request, RetryConfig? retryConfig = null) + + /// + /// Create supplier. + /// + /// + /// The *Create supplier* endpoint creates a new supplier for a given company's connection.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create/update supplier model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateSupplierRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -303,7 +363,7 @@ public async Task CreateAsync(CreateSupplierRequest requ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -407,5 +467,6 @@ public async Task CreateAsync(CreateSupplierRequest requ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingTransactions.cs b/lending/Codat/Lending/CodatLendingTransactions.cs index 0f8069bde..36ea629c4 100644 --- a/lending/Codat/Lending/CodatLendingTransactions.cs +++ b/lending/Codat/Lending/CodatLendingTransactions.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ICodatLendingTransactions { - /// - /// List transactions - /// + /// List transactions. + /// /// - /// The *List transactions* endpoint returns a list of transactions for a given company's connection.
+ /// The *List transactions* endpoint returns a list of transactions for a given company's connection.
///
/// Transactions provide an immutable source of up-to-date information on income and expenditure.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListBankingTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListBankingTransactionsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get bank transaction - /// + /// Get bank transaction. + /// /// /// The *Get transaction* endpoint returns a single transaction for a given transactionId.
///
/// Transactions provide an immutable source of up-to-date information on income and expenditure.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetBankingTransactionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetBankingTransactionRequest request, + RetryConfig? retryConfig = null + ); } public class CodatLendingTransactions: ICodatLendingTransactions { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingTransactions(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListBankingTransactionsRequest request, RetryConfig? retryConfig = null) + /// + /// List transactions. + /// + /// + /// The *List transactions* endpoint returns a list of transactions for a given company's connection.
+ ///
+ /// Transactions provide an immutable source of up-to-date information on income and expenditure.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListBankingTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListBankingTransact httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListBankingTransact throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetBankingTransactionRequest request, RetryConfig? retryConfig = null) + + /// + /// Get bank transaction. + /// + /// + /// The *Get transaction* endpoint returns a single transaction for a given transactionId.
+ ///
+ /// Transactions provide an immutable source of up-to-date information on income and expenditure.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetBankingTransactionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetBankingTransactionR httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetBankingTransactionR throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CodatLendingTransfers.cs b/lending/Codat/Lending/CodatLendingTransfers.cs index 8ba70d183..a00d2977b 100644 --- a/lending/Codat/Lending/CodatLendingTransfers.cs +++ b/lending/Codat/Lending/CodatLendingTransfers.cs @@ -24,10 +24,9 @@ namespace Codat.Lending public interface ICodatLendingTransfers { - /// - /// Get create transfer model - /// + /// Get create transfer model. + /// /// /// The *Get create transfer model* endpoint returns the expected data for the request payload when creating a transfer for a given company and integration.
///
@@ -35,17 +34,26 @@ public interface ICodatLendingTransfers ///
/// **Integration-specific behavior**
///
- /// See the *response examples* for integration-specific indicative models.
- /// + /// See the *response examples* for integration-specific indicative models. ///
- /// - Task GetCreateModelAsync(GetCreateTransfersModelRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCreateModelAsync( + GetCreateTransfersModelRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create transfer - /// + /// Create transfer. + /// /// - /// The *Create transfer* endpoint creates a new transfer for a given company's connection.
+ /// The *Create transfer* endpoint creates a new transfer for a given company's connection.
///
/// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
///
@@ -53,25 +61,54 @@ public interface ICodatLendingTransfers ///
/// Required data may vary by integration. To see what data to post, first call Get create transfer model. ///
- /// - Task CreateAsync(CreateTransferRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync(CreateTransferRequest request, RetryConfig? retryConfig = null); } public class CodatLendingTransfers: ICodatLendingTransfers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CodatLendingTransfers(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCreateModelAsync(GetCreateTransfersModelRequest request, RetryConfig? retryConfig = null) + /// + /// Get create transfer model. + /// + /// + /// The *Get create transfer model* endpoint returns the expected data for the request payload when creating a transfer for a given company and integration.
+ ///
+ /// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// See the *response examples* for integration-specific indicative models. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCreateModelAsync( + GetCreateTransfersModelRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -131,7 +168,7 @@ public async Task GetCreateModelAsync(GetCreate httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -236,7 +273,31 @@ public async Task GetCreateModelAsync(GetCreate throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateTransferRequest request, RetryConfig? retryConfig = null) + + /// + /// Create transfer. + /// + /// + /// The *Create transfer* endpoint creates a new transfer for a given company's connection.
+ ///
+ /// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
+ ///
+ /// **Integration-specific behavior**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create transfer model. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateTransferRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -302,7 +363,7 @@ public async Task CreateAsync(CreateTransferRequest requ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -406,5 +467,6 @@ public async Task CreateAsync(CreateTransferRequest requ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Companies.cs b/lending/Codat/Lending/Companies.cs index 5ac024f14..324feedc7 100644 --- a/lending/Codat/Lending/Companies.cs +++ b/lending/Codat/Lending/Companies.cs @@ -23,14 +23,13 @@ namespace Codat.Lending using System.Threading.Tasks; /// - /// Create and manage your SMB users' companies. + /// Create and manage your SMB users' companies. /// public interface ICompanies { - /// - /// List companies - /// + /// List companies. + /// /// /// The *List companies* endpoint returns a list of companies associated to your instances.
///
@@ -50,12 +49,21 @@ public interface ICompanies /// - Region: `region != uk`
/// - Owning team and region: `region = uk && owningTeam = invoice-finance` ///
- /// - Task ListAsync(ListCompaniesRequest? request = null, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCompaniesRequest? request = null, + RetryConfig? retryConfig = null + ); /// - /// Create company - /// + /// Create company. + /// /// /// Use the *Create company* endpoint to create a new company that represents your customer in Codat.
///
@@ -64,79 +72,145 @@ public interface ICompanies ///
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`. ///
- /// - Task CreateAsync(CompanyRequestBody? request = null, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CompanyRequestBody? request = null, + RetryConfig? retryConfig = null + ); /// - /// Replace company - /// + /// Replace company. + /// /// - /// Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
+ /// Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
///
/// A company represents a business sharing access to their data.
/// Each company can have multiple connections 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. ///
- /// - Task ReplaceAsync(ReplaceCompanyRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ReplaceAsync(ReplaceCompanyRequest request, RetryConfig? retryConfig = null); /// - /// Update company - /// + /// Update company. + /// /// /// Use the *Update company* endpoint to update the name, description, or tags of the company.
///
- /// The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
+ /// The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
///
/// A company represents a business sharing access to their data. ///
- /// - Task UpdateAsync(UpdateCompanyRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UpdateAsync(UpdateCompanyRequest request, RetryConfig? retryConfig = null); /// - /// Delete a company - /// + /// Delete a company. + /// /// /// The *Delete company* endpoint permanently deletes a company, its connections and any cached data. This operation is irreversible.
///
/// A company represents a business sharing access to their data.
- /// Each company can have multiple connections 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.
- /// + /// Each company can have multiple connections 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. ///
- /// - Task DeleteAsync(DeleteCompanyRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DeleteAsync(DeleteCompanyRequest request, RetryConfig? retryConfig = null); /// - /// Get company - /// + /// Get company. + /// /// /// The *Get company* endpoint returns a single company for a given `companyId`.
///
/// A company represents a business sharing access to their data.
- /// Each company can have multiple connections 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.
- /// + /// Each company can have multiple connections 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. ///
- /// - Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null); } /// - /// Create and manage your SMB users' companies. + /// Create and manage your SMB users' companies. /// public class Companies: ICompanies { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Companies(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCompaniesRequest? request = null, RetryConfig? retryConfig = null) + /// + /// List companies. + /// + /// + /// The *List companies* endpoint returns a list of companies associated to your instances.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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.
+ ///
+ /// ## Filter by tags
+ ///
+ /// The *List companies* endpoint supports the filtering of companies using tags. It supports the following operators with Codat’s query language:
+ ///
+ /// - equals (`=`)
+ /// - not equals (`!=`)
+ /// - contains (`~`)
+ ///
+ /// For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
+ /// - Foreign key: `uid = {yourCustomerId}`
+ /// - Region: `region != uk`
+ /// - Owning team and region: `region = uk && owningTeam = invoice-finance` + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCompaniesRequest? request = null, + RetryConfig? retryConfig = null + ) { string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); var urlString = URLBuilder.Build(baseUrl, "/companies", request, null); @@ -194,7 +268,7 @@ public async Task ListAsync(ListCompaniesRequest? request httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -299,10 +373,31 @@ public async Task ListAsync(ListCompaniesRequest? request throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CompanyRequestBody? request = null, RetryConfig? retryConfig = null) + + /// + /// Create company. + /// + /// + /// Use the *Create company* endpoint to create a new company that represents your customer in Codat.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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.
+ ///
+ /// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CompanyRequestBody? request = null, + RetryConfig? retryConfig = null + ) { string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = baseUrl + "/companies"; var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); @@ -364,7 +459,7 @@ public async Task CreateAsync(CompanyRequestBody? request httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -469,7 +564,28 @@ public async Task CreateAsync(CompanyRequestBody? request throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ReplaceAsync(ReplaceCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Replace company. + /// + /// + /// Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ReplaceAsync( + ReplaceCompanyRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -535,7 +651,7 @@ public async Task ReplaceAsync(ReplaceCompanyRequest req httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -640,7 +756,29 @@ public async Task ReplaceAsync(ReplaceCompanyRequest req throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UpdateAsync(UpdateCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Update company. + /// + /// + /// Use the *Update company* endpoint to update the name, description, or tags of the company.
+ ///
+ /// The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
+ ///
+ /// A company represents a business sharing access to their data. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UpdateAsync( + UpdateCompanyRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -706,7 +844,7 @@ public async Task UpdateAsync(UpdateCompanyRequest reques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -811,7 +949,28 @@ public async Task UpdateAsync(UpdateCompanyRequest reques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DeleteAsync(DeleteCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Delete a company. + /// + /// + /// The *Delete company* endpoint permanently deletes a company, its connections and any cached data. This operation is irreversible.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DeleteAsync( + DeleteCompanyRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -871,7 +1030,7 @@ public async Task DeleteAsync(DeleteCompanyRequest reques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -958,7 +1117,25 @@ public async Task DeleteAsync(DeleteCompanyRequest reques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null) + + /// + /// Get company. + /// + /// + /// The *Get company* endpoint returns a single company for a given `companyId`.
+ ///
+ /// A company represents a business sharing access to their data.
+ /// Each company can have multiple connections 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. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetCompanyRequest request, RetryConfig? retryConfig = null) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -1018,7 +1195,7 @@ public async Task GetAsync(GetCompanyRequest request, RetryC httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -1122,5 +1299,6 @@ public async Task GetAsync(GetCompanyRequest request, RetryC throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CompanyInfo.cs b/lending/Codat/Lending/CompanyInfo.cs index 6c395746b..118828ffe 100644 --- a/lending/Codat/Lending/CompanyInfo.cs +++ b/lending/Codat/Lending/CompanyInfo.cs @@ -27,28 +27,47 @@ namespace Codat.Lending /// public interface ICompanyInfo { - /// - /// Get company accounting profile - /// + /// Get company accounting profile. + /// /// /// Gets the latest basic info for a company. /// - /// - Task GetAccountingProfileAsync(GetAccountingProfileRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAccountingProfileAsync( + GetAccountingProfileRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get company commerce profile - /// + /// Get company commerce profile. + /// /// /// Retrieve information about the company, as seen in the commerce
/// platform.
///
/// This may include information like addresses, tax registration details and
- /// social media or website information." + /// social media or website information." ///
- /// - Task GetCommerceProfileAsync(GetCommerceProfileRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCommerceProfileAsync( + GetCommerceProfileRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -56,19 +75,35 @@ public interface ICompanyInfo /// public class CompanyInfo: ICompanyInfo { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CompanyInfo(SDKConfig config) { SDKConfiguration = config; } - public async Task GetAccountingProfileAsync(GetAccountingProfileRequest request, RetryConfig? retryConfig = null) + /// + /// Get company accounting profile. + /// + /// + /// Gets the latest basic info for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAccountingProfileAsync( + GetAccountingProfileRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +163,7 @@ public async Task GetAccountingProfileAsync(GetAcc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +268,29 @@ public async Task GetAccountingProfileAsync(GetAcc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetCommerceProfileAsync(GetCommerceProfileRequest request, RetryConfig? retryConfig = null) + + /// + /// Get company commerce profile. + /// + /// + /// Retrieve information about the company, as seen in the commerce
+ /// platform.
+ ///
+ /// This may include information like addresses, tax registration details and
+ /// social media or website information." + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCommerceProfileAsync( + GetCommerceProfileRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +350,7 @@ public async Task GetCommerceProfileAsync(GetCommerc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +454,6 @@ public async Task GetCommerceProfileAsync(GetCommerc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Connections.cs b/lending/Codat/Lending/Connections.cs index c8a5e8d28..a9e94918b 100644 --- a/lending/Codat/Lending/Connections.cs +++ b/lending/Codat/Lending/Connections.cs @@ -27,54 +27,97 @@ namespace Codat.Lending /// public interface IConnections { - /// - /// List connections - /// + /// List connections. + /// /// /// List the connections for a company. /// - /// - Task ListAsync(ListConnectionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync(ListConnectionsRequest request, RetryConfig? retryConfig = null); /// - /// Create connection - /// + /// Create connection. + /// /// /// Creates a connection for the company by providing a valid `platformKey`.
///
- /// Use the List Integrations endpoint to access valid platform keys. + /// Use the List Integrations endpoint to access valid platform keys. ///
- /// - Task CreateAsync(CreateConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateConnectionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get connection - /// + /// Get connection. + /// /// /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. /// - /// - Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null); /// - /// Delete connection - /// + /// Delete connection. + /// /// /// Revoke and remove a connection from a company.
/// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. ///
- /// - Task DeleteAsync(DeleteConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DeleteAsync( + DeleteConnectionRequest request, + RetryConfig? retryConfig = null + ); /// - /// Unlink connection - /// + /// Unlink connection. + /// /// /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. /// - /// - Task UnlinkAsync(UnlinkConnectionRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UnlinkAsync( + UnlinkConnectionRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -82,19 +125,35 @@ public interface IConnections /// public class Connections: IConnections { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Connections(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListConnectionsRequest request, RetryConfig? retryConfig = null) + /// + /// List connections. + /// + /// + /// List the connections for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListConnectionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -154,7 +213,7 @@ public async Task ListAsync(ListConnectionsRequest requ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -259,7 +318,27 @@ public async Task ListAsync(ListConnectionsRequest requ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateAsync(CreateConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Create connection. + /// + /// + /// Creates a connection for the company by providing a valid `platformKey`.
+ ///
+ /// Use the List Integrations endpoint to access valid platform keys. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateConnectionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -325,7 +404,7 @@ public async Task CreateAsync(CreateConnectionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -430,7 +509,22 @@ public async Task CreateAsync(CreateConnectionRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Get connection. + /// + /// + /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync(GetConnectionRequest request, RetryConfig? retryConfig = null) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -490,7 +584,7 @@ public async Task GetAsync(GetConnectionRequest request, httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -595,7 +689,26 @@ public async Task GetAsync(GetConnectionRequest request, throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DeleteAsync(DeleteConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Delete connection. + /// + /// + /// Revoke and remove a connection from a company.
+ /// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DeleteAsync( + DeleteConnectionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -655,7 +768,7 @@ public async Task DeleteAsync(DeleteConnectionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -742,7 +855,25 @@ public async Task DeleteAsync(DeleteConnectionRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UnlinkAsync(UnlinkConnectionRequest request, RetryConfig? retryConfig = null) + + /// + /// Unlink connection. + /// + /// + /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UnlinkAsync( + UnlinkConnectionRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -808,7 +939,7 @@ public async Task UnlinkAsync(UnlinkConnectionRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -912,5 +1043,6 @@ public async Task UnlinkAsync(UnlinkConnectionRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CreateOperations.cs b/lending/Codat/Lending/CreateOperations.cs index ff9f84317..04b9befd4 100644 --- a/lending/Codat/Lending/CreateOperations.cs +++ b/lending/Codat/Lending/CreateOperations.cs @@ -24,41 +24,76 @@ namespace Codat.Lending public interface ICreateOperations { - /// - /// Get create operation - /// + /// Get create operation. + /// /// /// Retrieve create operation. /// - /// - Task GetAsync(GetCreateOperationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCreateOperationRequest request, + RetryConfig? retryConfig = null + ); /// - /// List create operations - /// + /// List create operations. + /// /// /// List create operations. /// - /// - Task ListAsync(ListCreateOperationsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCreateOperationsRequest request, + RetryConfig? retryConfig = null + ); } public class CreateOperations: ICreateOperations { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CreateOperations(SDKConfig config) { SDKConfiguration = config; } - public async Task GetAsync(GetCreateOperationRequest request, RetryConfig? retryConfig = null) + /// + /// Get create operation. + /// + /// + /// Retrieve create operation. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCreateOperationRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -118,7 +153,7 @@ public async Task GetAsync(GetCreateOperationRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -223,7 +258,25 @@ public async Task GetAsync(GetCreateOperationRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAsync(ListCreateOperationsRequest request, RetryConfig? retryConfig = null) + + /// + /// List create operations. + /// + /// + /// List create operations. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCreateOperationsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -283,7 +336,7 @@ public async Task ListAsync(ListCreateOperationsRe httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -387,5 +440,6 @@ public async Task ListAsync(ListCreateOperationsRe throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/CreditNotes.cs b/lending/Codat/Lending/CreditNotes.cs index f4df11c01..82d53cfbe 100644 --- a/lending/Codat/Lending/CreditNotes.cs +++ b/lending/Codat/Lending/CreditNotes.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ICreditNotes { - /// - /// List credit notes - /// + /// List credit notes. + /// /// - /// The *List credit notes* endpoint returns a list of credit notes for a given company's connection.
+ /// The *List credit notes* endpoint returns a list of credit notes for a given company's connection.
///
/// Credit notes are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingCreditNotesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingCreditNotesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get credit note - /// + /// Get credit note. + /// /// /// The *Get credit note* endpoint returns a single credit note for a given creditNoteId.
///
/// Credit notes are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingCreditNoteRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingCreditNoteRequest request, + RetryConfig? retryConfig = null + ); } public class CreditNotes: ICreditNotes { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public CreditNotes(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingCreditNotesRequest request, RetryConfig? retryConfig = null) + /// + /// List credit notes. + /// + /// + /// The *List credit notes* endpoint returns a list of credit notes for a given company's connection.
+ ///
+ /// Credit notes are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingCreditNotesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountingCre httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountingCre throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingCreditNoteRequest request, RetryConfig? retryConfig = null) + + /// + /// Get credit note. + /// + /// + /// The *Get credit note* endpoint returns a single credit note for a given creditNoteId.
+ ///
+ /// Credit notes are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingCreditNoteRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingCreditN httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingCreditN throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Customers.cs b/lending/Codat/Lending/Customers.cs index 230dec126..506a16ba2 100644 --- a/lending/Codat/Lending/Customers.cs +++ b/lending/Codat/Lending/Customers.cs @@ -24,85 +24,151 @@ namespace Codat.Lending public interface ICustomers { - /// - /// List customers - /// + /// List customers. + /// /// - /// The *List customers* endpoint returns a list of customers for a given company's connection.
+ /// The *List customers* endpoint returns a list of customers for a given company's connection.
///
/// Customers are people or organizations that buy goods or services from the SMB.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingCustomersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingCustomersRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get customer - /// + /// Get customer. + /// /// /// The *Get customer* endpoint returns a single customer for a given customerId.
///
/// Customers are people or organizations that buy goods or services from the SMB.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingCustomerRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingCustomerRequest request, + RetryConfig? retryConfig = null + ); /// - /// List customer attachments - /// + /// List customer attachments. + /// /// /// The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.
///
/// Customers are people or organizations that buy goods or services from the SMB. ///
- /// - Task ListAttachmentsAsync(ListAccountingCustomerAttachmentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAttachmentsAsync( + ListAccountingCustomerAttachmentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get customer attachment - /// + /// Get customer attachment. + /// /// /// The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.
///
- /// Customers are people or organizations that buy goods or services from the SMB.
- /// + /// Customers are people or organizations that buy goods or services from the SMB. ///
- /// - Task GetAttachmentAsync(GetAccountingCustomerAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAttachmentAsync( + GetAccountingCustomerAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download customer attachment - /// + /// Download customer attachment. + /// /// /// The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.
///
/// Customers are people or organizations that buy goods or services from the SMB. ///
- /// - Task DownloadAttachmentAsync(DownloadAccountingCustomerAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAttachmentAsync( + DownloadAccountingCustomerAttachmentRequest request, + RetryConfig? retryConfig = null + ); } public class Customers: ICustomers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Customers(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingCustomersRequest request, RetryConfig? retryConfig = null) + /// + /// List customers. + /// + /// + /// The *List customers* endpoint returns a list of customers for a given company's connection.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingCustomersRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -162,7 +228,7 @@ public async Task ListAsync(ListAccountingCusto httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -267,7 +333,29 @@ public async Task ListAsync(ListAccountingCusto throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingCustomerRequest request, RetryConfig? retryConfig = null) + + /// + /// Get customer. + /// + /// + /// The *Get customer* endpoint returns a single customer for a given customerId.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingCustomerRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -327,7 +415,7 @@ public async Task GetAsync(GetAccountingCustomerR httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -432,7 +520,27 @@ public async Task GetAsync(GetAccountingCustomerR throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAttachmentsAsync(ListAccountingCustomerAttachmentsRequest request, RetryConfig? retryConfig = null) + + /// + /// List customer attachments. + /// + /// + /// The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAttachmentsAsync( + ListAccountingCustomerAttachmentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -492,7 +600,7 @@ public async Task ListAttachmentsAsyn httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -597,7 +705,27 @@ public async Task ListAttachmentsAsyn throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAttachmentAsync(GetAccountingCustomerAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get customer attachment. + /// + /// + /// The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAttachmentAsync( + GetAccountingCustomerAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -657,7 +785,7 @@ public async Task GetAttachmentAsync(Ge httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -762,7 +890,27 @@ public async Task GetAttachmentAsync(Ge throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAttachmentAsync(DownloadAccountingCustomerAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Download customer attachment. + /// + /// + /// The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.
+ ///
+ /// Customers are people or organizations that buy goods or services from the SMB. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAttachmentAsync( + DownloadAccountingCustomerAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -822,7 +970,7 @@ public async Task DownloadAttachme httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -915,5 +1063,6 @@ public async Task DownloadAttachme throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/DataIntegrity.cs b/lending/Codat/Lending/DataIntegrity.cs index b9d11b7d7..80641bbda 100644 --- a/lending/Codat/Lending/DataIntegrity.cs +++ b/lending/Codat/Lending/DataIntegrity.cs @@ -27,10 +27,9 @@ namespace Codat.Lending /// public interface IDataIntegrity { - /// - /// Get data integrity status - /// + /// Get data integrity status. + /// /// /// The *Get data integrity status* endpoint returns the status for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching.
/// This endpoint helps you understand whether match data is available and, if so, how to usefully query it.
@@ -41,12 +40,22 @@ public interface IDataIntegrity /// - When the results were generated, and their status.
/// - The connection IDs, amounts, and dates involved to support useful querying. ///
- /// - Task StatusAsync(GetDataIntegrityStatusRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task StatusAsync( + GetDataIntegrityStatusRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get data integrity summaries - /// + /// Get data integrity summaries. + /// /// /// The *Get data integrity summary* endpoint returns a summary of match results for a given data type filtered by a query string in the Codat query language.
///
@@ -54,19 +63,39 @@ public interface IDataIntegrity ///
/// The endpoint response includes only the summary results, not transactions. To view match data for transactions, use the List data integrity details endpoint. ///
- /// - Task SummariesAsync(GetDataIntegritySummariesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task SummariesAsync( + GetDataIntegritySummariesRequest request, + RetryConfig? retryConfig = null + ); /// - /// List data integrity details - /// + /// List data integrity details. + /// /// /// The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results.
///
/// The details are paginated and support ordering, following the same conventions as our other data endpoints. ///
- /// - Task DetailsAsync(ListDataIntegrityDetailsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DetailsAsync( + ListDataIntegrityDetailsRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -74,19 +103,42 @@ public interface IDataIntegrity /// public class DataIntegrity: IDataIntegrity { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public DataIntegrity(SDKConfig config) { SDKConfiguration = config; } - public async Task StatusAsync(GetDataIntegrityStatusRequest request, RetryConfig? retryConfig = null) + /// + /// Get data integrity status. + /// + /// + /// The *Get data integrity status* endpoint returns the status for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching.
+ /// This endpoint helps you understand whether match data is available and, if so, how to usefully query it.
+ ///
+ /// The response tells you:
+ ///
+ /// - Whether match results are available.
+ /// - When the results were generated, and their status.
+ /// - The connection IDs, amounts, and dates involved to support useful querying. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task StatusAsync( + GetDataIntegrityStatusRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -146,7 +198,7 @@ public async Task StatusAsync(GetDataIntegritySt httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -251,7 +303,29 @@ public async Task StatusAsync(GetDataIntegritySt throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task SummariesAsync(GetDataIntegritySummariesRequest request, RetryConfig? retryConfig = null) + + /// + /// Get data integrity summaries. + /// + /// + /// The *Get data integrity summary* endpoint returns a summary of match results for a given data type filtered by a query string in the Codat query language.
+ ///
+ /// For example, if you wanted to see summary match results only for transactions after 1 December 2020, you could include a query parameter of `query=date>2020-12-01`.
+ ///
+ /// The endpoint response includes only the summary results, not transactions. To view match data for transactions, use the List data integrity details endpoint. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task SummariesAsync( + GetDataIntegritySummariesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -311,7 +385,7 @@ public async Task SummariesAsync(GetDataInteg httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -416,7 +490,27 @@ public async Task SummariesAsync(GetDataInteg throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DetailsAsync(ListDataIntegrityDetailsRequest request, RetryConfig? retryConfig = null) + + /// + /// List data integrity details. + /// + /// + /// The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results.
+ ///
+ /// The details are paginated and support ordering, following the same conventions as our other data endpoints. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DetailsAsync( + ListDataIntegrityDetailsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -476,7 +570,7 @@ public async Task DetailsAsync(ListDataIntegri httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -580,5 +674,6 @@ public async Task DetailsAsync(ListDataIntegri throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/DirectCosts.cs b/lending/Codat/Lending/DirectCosts.cs index 9f9701bfc..ed0abc024 100644 --- a/lending/Codat/Lending/DirectCosts.cs +++ b/lending/Codat/Lending/DirectCosts.cs @@ -24,86 +24,151 @@ namespace Codat.Lending public interface IDirectCosts { - /// - /// List direct costs - /// + /// List direct costs. + /// /// - /// The *List direct costs* endpoint returns a list of direct costs for a given company's connection.
+ /// The *List direct costs* endpoint returns a list of direct costs for a given company's connection.
///
- /// Direct costs are business expenses that don't impact Accounts Payable.
+ /// Direct costs are business expenses that don't impact Accounts Payable.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingDirectCostsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingDirectCostsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get direct cost - /// + /// Get direct cost. + /// /// /// The *Get direct cost* endpoint returns a single direct cost for a given directCostId.
///
- /// Direct costs are business expenses that don't impact Accounts Payable.
+ /// Direct costs are business expenses that don't impact Accounts Payable.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingDirectCostRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingDirectCostRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get direct cost attachment - /// + /// Get direct cost attachment. + /// /// /// The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.
///
- /// Direct costs are business expenses that don't impact Accounts Payable. + /// Direct costs are business expenses that don't impact Accounts Payable. ///
- /// - Task GetAttachmentAsync(GetAccountingDirectCostAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAttachmentAsync( + GetAccountingDirectCostAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download direct cost attachment - /// + /// Download direct cost attachment. + /// /// /// The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.
///
- /// Direct costs are business expenses that don't impact Accounts Payable.
- /// + /// Direct costs are business expenses that don't impact Accounts Payable. ///
- /// - Task DownloadAttachmentAsync(DownloadAccountingDirectCostAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAttachmentAsync( + DownloadAccountingDirectCostAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// List direct cost attachments - /// + /// List direct cost attachments. + /// /// /// The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.
///
- /// Direct costs are business expenses that don't impact Accounts Payable.
- /// + /// Direct costs are business expenses that don't impact Accounts Payable. ///
- /// - Task ListAttachmentsAsync(ListAccountingDirectCostAttachmentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAttachmentsAsync( + ListAccountingDirectCostAttachmentsRequest request, + RetryConfig? retryConfig = null + ); } public class DirectCosts: IDirectCosts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public DirectCosts(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingDirectCostsRequest request, RetryConfig? retryConfig = null) + /// + /// List direct costs. + /// + /// + /// The *List direct costs* endpoint returns a list of direct costs for a given company's connection.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingDirectCostsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -163,7 +228,7 @@ public async Task ListAsync(ListAccountingDir httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -268,7 +333,29 @@ public async Task ListAsync(ListAccountingDir throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingDirectCostRequest request, RetryConfig? retryConfig = null) + + /// + /// Get direct cost. + /// + /// + /// The *Get direct cost* endpoint returns a single direct cost for a given directCostId.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingDirectCostRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -328,7 +415,7 @@ public async Task GetAsync(GetAccountingDirectC httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -433,7 +520,27 @@ public async Task GetAsync(GetAccountingDirectC throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAttachmentAsync(GetAccountingDirectCostAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get direct cost attachment. + /// + /// + /// The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAttachmentAsync( + GetAccountingDirectCostAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -493,7 +600,7 @@ public async Task GetAttachmentAsync( httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -598,7 +705,27 @@ public async Task GetAttachmentAsync( throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAttachmentAsync(DownloadAccountingDirectCostAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Download direct cost attachment. + /// + /// + /// The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAttachmentAsync( + DownloadAccountingDirectCostAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -658,7 +785,7 @@ public async Task DownloadAttach httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -752,7 +879,27 @@ public async Task DownloadAttach throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAttachmentsAsync(ListAccountingDirectCostAttachmentsRequest request, RetryConfig? retryConfig = null) + + /// + /// List direct cost attachments. + /// + /// + /// The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.
+ ///
+ /// Direct costs are business expenses that don't impact Accounts Payable. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAttachmentsAsync( + ListAccountingDirectCostAttachmentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -812,7 +959,7 @@ public async Task ListAttachmentsAs httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -916,5 +1063,6 @@ public async Task ListAttachmentsAs throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/DirectIncomes.cs b/lending/Codat/Lending/DirectIncomes.cs index 75f36c2ac..d543291d6 100644 --- a/lending/Codat/Lending/DirectIncomes.cs +++ b/lending/Codat/Lending/DirectIncomes.cs @@ -24,84 +24,151 @@ namespace Codat.Lending public interface IDirectIncomes { - /// - /// List direct incomes - /// + /// List direct incomes. + /// /// - /// The *List direct incomes* endpoint returns a list of direct incomes for a given company's connection.
+ /// The *List direct incomes* endpoint returns a list of direct incomes for a given company's connection.
///
- /// Direct incomes are incomes received directly from the business' operations at the point of the sale.
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingDirectIncomesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingDirectIncomesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get direct income - /// + /// Get direct income. + /// /// /// The *Get direct income* endpoint returns a single direct income for a given directIncomeId.
///
- /// Direct incomes are incomes received directly from the business' operations at the point of the sale.
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingDirectIncomeRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingDirectIncomeRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get direct income attachment - /// + /// Get direct income attachment. + /// /// /// The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.
///
- /// Direct incomes are incomes received directly from the business' operations at the point of the sale. + /// Direct incomes are incomes received directly from the business' operations at the point of the sale. ///
- /// - Task GetAttachmentAsync(GetAccountingDirectIncomeAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAttachmentAsync( + GetAccountingDirectIncomeAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download direct income attachment - /// + /// Download direct income attachment. + /// /// /// The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.
///
- /// Direct incomes are incomes received directly from the business' operations at the point of the sale. + /// Direct incomes are incomes received directly from the business' operations at the point of the sale. ///
- /// - Task DownloadAttachmentAsync(DownloadAccountingDirectIncomeAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAttachmentAsync( + DownloadAccountingDirectIncomeAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// List direct income attachments - /// + /// List direct income attachments. + /// /// /// The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.
///
- /// Direct incomes are incomes received directly from the business' operations at the point of the sale. + /// Direct incomes are incomes received directly from the business' operations at the point of the sale. ///
- /// - Task ListAttachmentsAsync(ListAccountingDirectIncomeAttachmentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAttachmentsAsync( + ListAccountingDirectIncomeAttachmentsRequest request, + RetryConfig? retryConfig = null + ); } public class DirectIncomes: IDirectIncomes { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public DirectIncomes(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingDirectIncomesRequest request, RetryConfig? retryConfig = null) + /// + /// List direct incomes. + /// + /// + /// The *List direct incomes* endpoint returns a list of direct incomes for a given company's connection.
+ ///
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingDirectIncomesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -161,7 +228,7 @@ public async Task ListAsync(ListAccountingD httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -266,7 +333,29 @@ public async Task ListAsync(ListAccountingD throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingDirectIncomeRequest request, RetryConfig? retryConfig = null) + + /// + /// Get direct income. + /// + /// + /// The *Get direct income* endpoint returns a single direct income for a given directIncomeId.
+ ///
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingDirectIncomeRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -326,7 +415,7 @@ public async Task GetAsync(GetAccountingDirec httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -431,7 +520,27 @@ public async Task GetAsync(GetAccountingDirec throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAttachmentAsync(GetAccountingDirectIncomeAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get direct income attachment. + /// + /// + /// The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.
+ ///
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAttachmentAsync( + GetAccountingDirectIncomeAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -491,7 +600,7 @@ public async Task GetAttachmentAsyn httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -596,7 +705,27 @@ public async Task GetAttachmentAsyn throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAttachmentAsync(DownloadAccountingDirectIncomeAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Download direct income attachment. + /// + /// + /// The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.
+ ///
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAttachmentAsync( + DownloadAccountingDirectIncomeAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -656,7 +785,7 @@ public async Task DownloadAtta httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -750,7 +879,27 @@ public async Task DownloadAtta throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAttachmentsAsync(ListAccountingDirectIncomeAttachmentsRequest request, RetryConfig? retryConfig = null) + + /// + /// List direct income attachments. + /// + /// + /// The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.
+ ///
+ /// Direct incomes are incomes received directly from the business' operations at the point of the sale. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAttachmentsAsync( + ListAccountingDirectIncomeAttachmentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -810,7 +959,7 @@ public async Task ListAttachments httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -914,5 +1063,6 @@ public async Task ListAttachments throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Disputes.cs b/lending/Codat/Lending/Disputes.cs index 451a276ba..c7827ced0 100644 --- a/lending/Codat/Lending/Disputes.cs +++ b/lending/Codat/Lending/Disputes.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IDisputes { - /// - /// List disputes - /// + /// List disputes. + /// /// - /// The *List disputes* endpoint returns a list of disputes for a given company's connection.
+ /// The *List disputes* endpoint returns a list of disputes for a given company's connection.
///
/// Disputes are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommerceDisputesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceDisputesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get dispute - /// + /// Get dispute. + /// /// /// The *Get dispute* endpoint returns a single dispute for a given disputeId.
///
/// Disputes are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommerceDisputeRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommerceDisputeRequest request, + RetryConfig? retryConfig = null + ); } public class Disputes: IDisputes { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Disputes(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceDisputesRequest request, RetryConfig? retryConfig = null) + /// + /// List disputes. + /// + /// + /// The *List disputes* endpoint returns a list of disputes for a given company's connection.
+ ///
+ /// Disputes are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceDisputesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommerceDisputesRe httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommerceDisputesRe throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceDisputeRequest request, RetryConfig? retryConfig = null) + + /// + /// Get dispute. + /// + /// + /// The *Get dispute* endpoint returns a single dispute for a given disputeId.
+ ///
+ /// Disputes are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceDisputeRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommerceDisputeRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommerceDisputeRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/ExcelReports.cs b/lending/Codat/Lending/ExcelReports.cs index 90e337579..332de610b 100644 --- a/lending/Codat/Lending/ExcelReports.cs +++ b/lending/Codat/Lending/ExcelReports.cs @@ -27,10 +27,9 @@ namespace Codat.Lending /// public interface IExcelReports { - /// - /// Generate Excel report - /// + /// Generate Excel report. + /// /// /// The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter.
///
@@ -41,21 +40,28 @@ public interface IExcelReports /// | reportType | Description |
/// |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
/// | `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || audit | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. |
- /// | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. |
+ /// | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. |
/// | `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. |
/// | `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. |
///
- /// Learn more about valid Excel report types.
- ///
- ///
- /// + /// Learn more about valid Excel report types. ///
- /// - Task GenerateAsync(GenerateExcelReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GenerateAsync( + GenerateExcelReportRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get Excel report status - /// + /// Get Excel report status. + /// /// /// The *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests.
///
@@ -63,12 +69,22 @@ public interface IExcelReports ///
/// When the report generation completes successfully, the `inProgress` property will be marked as `false` and the `success` field will be marked as `true`. ///
- /// - Task GetStatusAsync(GetExcelReportGenerationStatusRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetStatusAsync( + GetExcelReportGenerationStatusRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download Excel report - /// + /// Download Excel report. + /// /// /// The *Download Excel report* endpoint downloads the latest successfully generated Excel report of a specified report type for a given company.
///
@@ -76,8 +92,18 @@ public interface IExcelReports ///
/// You can learn more about valid Excel report types. ///
- /// - Task DownloadAsync(DownloadExcelReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAsync( + DownloadExcelReportRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -85,19 +111,48 @@ public interface IExcelReports /// public class ExcelReports: IExcelReports { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public ExcelReports(SDKConfig config) { SDKConfiguration = config; } - public async Task GenerateAsync(GenerateExcelReportRequest request, RetryConfig? retryConfig = null) + /// + /// Generate Excel report. + /// + /// + /// The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter.
+ ///
+ /// In response, the endpoint returns the status detailing the current state of the report generation request.
+ ///
+ /// ### Report types
+ ///
+ /// | reportType | Description |
+ /// |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+ /// | `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || audit | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. |
+ /// | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. |
+ /// | `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. |
+ /// | `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. |
+ ///
+ /// Learn more about valid Excel report types. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GenerateAsync( + GenerateExcelReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -157,7 +212,7 @@ public async Task GenerateAsync(GenerateExcelReport httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -262,7 +317,29 @@ public async Task GenerateAsync(GenerateExcelReport throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetStatusAsync(GetExcelReportGenerationStatusRequest request, RetryConfig? retryConfig = null) + + /// + /// Get Excel report status. + /// + /// + /// The *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests.
+ ///
+ /// Poll this endpoint to check the progress of the report once you have requested its generation. This will not affect the generation of the report.
+ ///
+ /// When the report generation completes successfully, the `inProgress` property will be marked as `false` and the `success` field will be marked as `true`. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetStatusAsync( + GetExcelReportGenerationStatusRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -322,7 +399,7 @@ public async Task GetStatusAsync(GetExce httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -427,7 +504,29 @@ public async Task GetStatusAsync(GetExce throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAsync(DownloadExcelReportRequest request, RetryConfig? retryConfig = null) + + /// + /// Download Excel report. + /// + /// + /// The *Download Excel report* endpoint downloads the latest successfully generated Excel report of a specified report type for a given company.
+ ///
+ /// The downloadable Excel file is returned in the response. You can save it to your local machine.
+ ///
+ /// You can learn more about valid Excel report types. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAsync( + DownloadExcelReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -487,7 +586,7 @@ public async Task DownloadAsync(DownloadExcelReport httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -580,5 +679,6 @@ public async Task DownloadAsync(DownloadExcelReport throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/FileUpload.cs b/lending/Codat/Lending/FileUpload.cs index 0156718cb..47efe95b0 100644 --- a/lending/Codat/Lending/FileUpload.cs +++ b/lending/Codat/Lending/FileUpload.cs @@ -27,28 +27,41 @@ namespace Codat.Lending /// public interface IFileUpload { - /// - /// List all files uploaded by a company - /// + /// List all files uploaded by a company. + /// /// - /// The *List files* endpoint returns a list of all files uploaded to Codat by the SMB. + /// The *List files* endpoint returns a list of all files uploaded to Codat by the SMB. /// - /// - Task ListUploadedAsync(ListFilesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListUploadedAsync(ListFilesRequest request, RetryConfig? retryConfig = null); /// - /// Download all files for a company - /// + /// Download all files for a company. + /// /// /// The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. /// - /// - Task DownloadAsync(DownloadFilesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAsync(DownloadFilesRequest request, RetryConfig? retryConfig = null); /// - /// Upload files for a company - /// + /// Upload files for a company. + /// /// /// The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data.
///
@@ -58,8 +71,15 @@ public interface IFileUpload /// - PDF, XLS, XLSX, XLSB, CSV, DOC, DOCX, PPT, PPTX, JPEG, JPG, and PNG files can be uploaded.
/// - Each file can be up to 10MB in size. ///
- /// - Task UploadAsync(UploadFilesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task UploadAsync(UploadFilesRequest request, RetryConfig? retryConfig = null); } /// @@ -67,19 +87,35 @@ public interface IFileUpload /// public class FileUpload: IFileUpload { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public FileUpload(SDKConfig config) { SDKConfiguration = config; } - public async Task ListUploadedAsync(ListFilesRequest request, RetryConfig? retryConfig = null) + /// + /// List all files uploaded by a company. + /// + /// + /// The *List files* endpoint returns a list of all files uploaded to Codat by the SMB. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListUploadedAsync( + ListFilesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -139,7 +175,7 @@ public async Task ListUploadedAsync(ListFilesRequest request, httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -244,7 +280,25 @@ public async Task ListUploadedAsync(ListFilesRequest request, throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAsync(DownloadFilesRequest request, RetryConfig? retryConfig = null) + + /// + /// Download all files for a company. + /// + /// + /// The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAsync( + DownloadFilesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -304,7 +358,7 @@ public async Task DownloadAsync(DownloadFilesRequest requ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -398,7 +452,28 @@ public async Task DownloadAsync(DownloadFilesRequest requ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task UploadAsync(UploadFilesRequest request, RetryConfig? retryConfig = null) + + /// + /// Upload files for a company. + /// + /// + /// The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data.
+ ///
+ /// Uploaded files must meet the following requirements:
+ ///
+ /// - Up to 20 files can be uploaded at a time.
+ /// - PDF, XLS, XLSX, XLSB, CSV, DOC, DOCX, PPT, PPTX, JPEG, JPG, and PNG files can be uploaded.
+ /// - Each file can be up to 10MB in size. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task UploadAsync(UploadFilesRequest request, RetryConfig? retryConfig = null) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -464,7 +539,7 @@ public async Task UploadAsync(UploadFilesRequest request, R httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -550,5 +625,6 @@ public async Task UploadAsync(UploadFilesRequest request, R throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/FinancialStatements.cs b/lending/Codat/Lending/FinancialStatements.cs index f9fee603b..1f06868cb 100644 --- a/lending/Codat/Lending/FinancialStatements.cs +++ b/lending/Codat/Lending/FinancialStatements.cs @@ -17,22 +17,44 @@ namespace Codat.Lending public interface IFinancialStatements { public IProfitAndLoss ProfitAndLoss { get; } + public IBalanceSheet BalanceSheet { get; } + public IAccounts Accounts { get; } + public ICashFlow CashFlow { get; } } public class FinancialStatements: IFinancialStatements { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// ProfitAndLoss SubSDK. + /// + /// public IProfitAndLoss ProfitAndLoss { get; private set; } + + /// + /// BalanceSheet SubSDK. + /// + /// public IBalanceSheet BalanceSheet { get; private set; } + + /// + /// Accounts SubSDK. + /// + /// public IAccounts Accounts { get; private set; } + + /// + /// CashFlow SubSDK. + /// + /// public ICashFlow CashFlow { get; private set; } public FinancialStatements(SDKConfig config) diff --git a/lending/Codat/Lending/Hooks/HookTypes.cs b/lending/Codat/Lending/Hooks/HookTypes.cs index 13985d1a3..edec64014 100644 --- a/lending/Codat/Lending/Hooks/HookTypes.cs +++ b/lending/Codat/Lending/Hooks/HookTypes.cs @@ -15,6 +15,9 @@ namespace Codat.Lending.Hooks using System.Threading.Tasks; using Codat.Lending.Utils; + /// + /// Base context class containing information passed to hooks during request execution. + /// public class HookContext { public SDKConfig SDKConfiguration { get; set; } @@ -42,18 +45,27 @@ public HookContext(HookContext hookCtx) } } + /// + /// Context passed to before request hooks. + /// public class BeforeRequestContext : HookContext { public BeforeRequestContext(HookContext hookCtx) : base(hookCtx) { } } + /// + /// Context passed to after success hooks. + /// public class AfterSuccessContext : HookContext { public AfterSuccessContext(HookContext hookCtx) : base(hookCtx) { } } + /// + /// Context passed to after error hooks. + /// public class AfterErrorContext : HookContext { public AfterErrorContext(HookContext hookCtx) @@ -79,7 +91,7 @@ public interface IBeforeRequestHook } /// - /// AfterSuccessAsync is called after the SDK receives a response. + /// AfterSuccessAsync hook is called after the SDK receives a successful response. /// The hook can modify the response before it is handled or throw an exception to stop the response from being handled. /// public interface IAfterSuccessHook @@ -88,16 +100,19 @@ public interface IAfterSuccessHook } /// - /// AfterErrorAsync is called after the SDK encounters an error, or a non-successful response. + /// AfterErrorAsync hook is called after the SDK encounters an error or a non-successful response. /// The hook can modify the response, if available, otherwise modify the error. - /// All hooks are called sequentially. If an error is returned, it will be passed to the subsequent hook implementing IAfterErrorHook. - /// If you want to prevent other AfterError hooks from being run, you can throw an FailEarlyException instead. + /// All hooks are called sequentially. If an error is returned, it will be passed to the subsequent after error hook. + /// If you want to prevent other after error hooks from being run, you can throw a instead. /// public interface IAfterErrorHook { Task<(HttpResponseMessage?, Exception?)> AfterErrorAsync(AfterErrorContext hookCtx, HttpResponseMessage? response, Exception? error); } + /// + /// Interface for managing SDK hook registrations. + /// public interface IHooks { void RegisterSDKInitHook(ISDKInitHook hook); diff --git a/lending/Codat/Lending/Hooks/SDKHooks.cs b/lending/Codat/Lending/Hooks/SDKHooks.cs index 7b15536c6..dc90041b8 100644 --- a/lending/Codat/Lending/Hooks/SDKHooks.cs +++ b/lending/Codat/Lending/Hooks/SDKHooks.cs @@ -15,8 +15,14 @@ namespace Codat.Lending.Hooks using System.Net.Http; using System.Threading.Tasks; + /// + /// Exception that can be thrown in implementations to prevent subsequent hooks from executing. + /// public sealed class FailEarlyException : Exception {} + /// + /// Manages and executes SDK hooks at various stages of the request lifecycle. + /// public class SDKHooks: IHooks { public List sdkInitHooks; @@ -33,26 +39,48 @@ public SDKHooks() HookRegistration.InitHooks(this); } + /// + /// Registers an SDK initialization hook to be executed when the SDK is initialized. + /// + /// The hook to register. public void RegisterSDKInitHook(ISDKInitHook hook) { this.sdkInitHooks.Add(hook); } + /// + /// Registers a before request hook to be executed before each HTTP request. + /// + /// The hook to register. public void RegisterBeforeRequestHook(IBeforeRequestHook hook) { this.beforeRequestHooks.Add(hook); } + /// + /// Registers an after success hook to be executed after successful HTTP responses. + /// + /// The hook to register. public void RegisterAfterSuccessHook(IAfterSuccessHook hook) { this.afterSuccessHooks.Add(hook); } + /// + /// Registers an after error hook to be executed after errors or non-successful responses. + /// + /// The hook to register. public void RegisterAfterErrorHook(IAfterErrorHook hook) { this.afterErrorHooks.Add(hook); } + /// + /// Executes all registered SDK initialization hooks. + /// + /// The base URL for the SDK. + /// The HTTP client. + /// The potentially modified base URL and HTTP client. public (string, ISpeakeasyHttpClient) SDKInit(string baseUrl, ISpeakeasyHttpClient client) { var urlAndClient = (baseUrl, client); @@ -69,6 +97,12 @@ public void RegisterAfterErrorHook(IAfterErrorHook hook) return urlAndClient; } + /// + /// Executes all registered before request hooks. + /// + /// The hook context containing request metadata. + /// The HTTP request message. + /// The potentially modified HTTP request message. public async Task BeforeRequestAsync(BeforeRequestContext hookCtx, HttpRequestMessage request) { foreach (var hook in this.beforeRequestHooks) @@ -85,6 +119,12 @@ public async Task BeforeRequestAsync(BeforeRequestContext ho return request; } + /// + /// Executes all registered after success hooks. + /// + /// The hook context containing request metadata. + /// The HTTP response message. + /// The potentially modified HTTP response message. public async Task AfterSuccessAsync(AfterSuccessContext hookCtx, HttpResponseMessage response) { foreach (var hook in this.afterSuccessHooks) @@ -101,6 +141,14 @@ public async Task AfterSuccessAsync(AfterSuccessContext hoo return response; } + /// + /// Executes all registered after error hooks. + /// + /// The hook context containing request metadata. + /// The HTTP response message, if available. + /// The exception that occurred, if any. + /// The potentially modified HTTP response message. + /// Thrown by a hook to prevent subsequent error hooks from executing. public async Task AfterErrorAsync(AfterErrorContext hookCtx, HttpResponseMessage? response, Exception? error) { (HttpResponseMessage?, Exception?) responseAndError = (response, error); diff --git a/lending/Codat/Lending/Invoices.cs b/lending/Codat/Lending/Invoices.cs index 2b6629352..9cda2c8ad 100644 --- a/lending/Codat/Lending/Invoices.cs +++ b/lending/Codat/Lending/Invoices.cs @@ -24,21 +24,30 @@ namespace Codat.Lending public interface IInvoices { - /// - /// List reconciled invoices - /// + /// List reconciled invoices. + /// /// - /// Gets a list of invoices linked to the corresponding banking transaction + /// Gets a list of invoices linked to the corresponding banking transaction. /// - /// - Task ListReconciledAsync(ListReconciledInvoicesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListReconciledAsync( + ListReconciledInvoicesRequest request, + RetryConfig? retryConfig = null + ); /// - /// List invoices - /// + /// List invoices. + /// /// - /// The *List invoices* endpoint returns a list of invoices for a given company's connection.
+ /// The *List invoices* endpoint returns a list of invoices for a given company's connection.
///
/// Invoices are itemized records of goods sold or services provided to a customer.
///
@@ -53,15 +62,24 @@ public interface IInvoices ///
/// ### Tips and traps
///
- /// To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache.
- /// + /// To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. ///
- /// - Task ListAsync(ListAccountingInvoicesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingInvoicesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get invoice - /// + /// Get invoice. + /// /// /// The *Get invoice* endpoint returns a single invoice for a given invoiceId.
///
@@ -71,72 +89,135 @@ public interface IInvoices ///
/// ### Tips and traps
///
- /// To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache.
- /// + /// To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. ///
- /// - Task GetAsync(GetAccountingInvoiceRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingInvoiceRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get invoice as PDF - /// + /// Get invoice as PDF. + /// /// /// Download invoice as a pdf. /// - /// - Task DownloadPdfAsync(DownloadAccountingInvoicePdfRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadPdfAsync( + DownloadAccountingInvoicePdfRequest request, + RetryConfig? retryConfig = null + ); /// - /// List invoice attachments - /// + /// List invoice attachments. + /// /// /// The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.
///
/// Invoices are itemized records of goods sold or services provided to a customer. ///
- /// - Task ListAttachmentsAsync(ListAccountingInvoiceAttachmentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAttachmentsAsync( + ListAccountingInvoiceAttachmentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get invoice attachment - /// + /// Get invoice attachment. + /// /// /// The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.
///
- /// Invoices are itemized records of goods sold or services provided to a customer.
- /// + /// Invoices are itemized records of goods sold or services provided to a customer. ///
- /// - Task GetAttachmentAsync(GetAccountingInvoiceAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAttachmentAsync( + GetAccountingInvoiceAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download invoice attachment - /// + /// Download invoice attachment. + /// /// /// The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
///
- /// Invoices are itemized records of goods sold or services provided to a customer.
- /// + /// Invoices are itemized records of goods sold or services provided to a customer. ///
- /// - Task DownloadAttachmentAsync(DownloadAccountingInvoiceAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAttachmentAsync( + DownloadAccountingInvoiceAttachmentRequest request, + RetryConfig? retryConfig = null + ); } public class Invoices: IInvoices { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Invoices(SDKConfig config) { SDKConfiguration = config; } - public async Task ListReconciledAsync(ListReconciledInvoicesRequest request, RetryConfig? retryConfig = null) + /// + /// List reconciled invoices. + /// + /// + /// Gets a list of invoices linked to the corresponding banking transaction. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListReconciledAsync( + ListReconciledInvoicesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -196,7 +277,7 @@ public async Task ListReconciledAsync(ListReconc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -301,7 +382,40 @@ public async Task ListReconciledAsync(ListReconc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAsync(ListAccountingInvoicesRequest request, RetryConfig? retryConfig = null) + + /// + /// List invoices. + /// + /// + /// The *List invoices* endpoint returns a list of invoices for a given company's connection.
+ ///
+ /// Invoices are itemized records of goods sold or services provided to a customer.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ ///
+ /// ### Useful queries
+ ///
+ /// - Outstanding invoices - `query = amountDue > 0`
+ /// - Invoices due after a certain date: `query = dueDate > 2021-01-28`
+ ///
+ /// Read more about querying.
+ ///
+ /// ### Tips and traps
+ ///
+ /// To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingInvoicesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -361,7 +475,7 @@ public async Task ListAsync(ListAccountingInvoic httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -466,7 +580,33 @@ public async Task ListAsync(ListAccountingInvoic throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingInvoiceRequest request, RetryConfig? retryConfig = null) + + /// + /// Get invoice. + /// + /// + /// The *Get invoice* endpoint returns a single invoice for a given invoiceId.
+ ///
+ /// Invoices are itemized records of goods sold or services provided to a customer.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ ///
+ /// ### Tips and traps
+ ///
+ /// To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingInvoiceRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -526,7 +666,7 @@ public async Task GetAsync(GetAccountingInvoiceReq httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -631,7 +771,25 @@ public async Task GetAsync(GetAccountingInvoiceReq throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadPdfAsync(DownloadAccountingInvoicePdfRequest request, RetryConfig? retryConfig = null) + + /// + /// Get invoice as PDF. + /// + /// + /// Download invoice as a pdf. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadPdfAsync( + DownloadAccountingInvoicePdfRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -691,7 +849,7 @@ public async Task DownloadPdfAsync(Downloa httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -785,7 +943,27 @@ public async Task DownloadPdfAsync(Downloa throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAttachmentsAsync(ListAccountingInvoiceAttachmentsRequest request, RetryConfig? retryConfig = null) + + /// + /// List invoice attachments. + /// + /// + /// The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.
+ ///
+ /// Invoices are itemized records of goods sold or services provided to a customer. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAttachmentsAsync( + ListAccountingInvoiceAttachmentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -845,7 +1023,7 @@ public async Task ListAttachmentsAsync httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -950,7 +1128,27 @@ public async Task ListAttachmentsAsync throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAttachmentAsync(GetAccountingInvoiceAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get invoice attachment. + /// + /// + /// The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.
+ ///
+ /// Invoices are itemized records of goods sold or services provided to a customer. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAttachmentAsync( + GetAccountingInvoiceAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -1010,7 +1208,7 @@ public async Task GetAttachmentAsync(Get httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -1115,7 +1313,27 @@ public async Task GetAttachmentAsync(Get throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAttachmentAsync(DownloadAccountingInvoiceAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Download invoice attachment. + /// + /// + /// The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
+ ///
+ /// Invoices are itemized records of goods sold or services provided to a customer. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAttachmentAsync( + DownloadAccountingInvoiceAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -1175,7 +1393,7 @@ public async Task DownloadAttachmen httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -1268,5 +1486,6 @@ public async Task DownloadAttachmen throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/JournalEntries.cs b/lending/Codat/Lending/JournalEntries.cs index 6ad58f5c4..c5739e711 100644 --- a/lending/Codat/Lending/JournalEntries.cs +++ b/lending/Codat/Lending/JournalEntries.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IJournalEntries { - /// - /// List journal entries - /// + /// List journal entries. + /// /// - /// The *List journal entries* endpoint returns a list of journal entries for a given company's connection.
+ /// The *List journal entries* endpoint returns a list of journal entries for a given company's connection.
///
- /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingJournalEntriesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingJournalEntriesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get journal entry - /// + /// Get journal entry. + /// /// /// The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.
///
- /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingJournalEntryRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingJournalEntryRequest request, + RetryConfig? retryConfig = null + ); } public class JournalEntries: IJournalEntries { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public JournalEntries(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingJournalEntriesRequest request, RetryConfig? retryConfig = null) + /// + /// List journal entries. + /// + /// + /// The *List journal entries* endpoint returns a list of journal entries for a given company's connection.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingJournalEntriesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccounting httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccounting throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingJournalEntryRequest request, RetryConfig? retryConfig = null) + + /// + /// Get journal entry. + /// + /// + /// The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingJournalEntryRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingJourn httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingJourn throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Journals.cs b/lending/Codat/Lending/Journals.cs index 7e31998d8..20a2e7562 100644 --- a/lending/Codat/Lending/Journals.cs +++ b/lending/Codat/Lending/Journals.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IJournals { - /// - /// List journals - /// + /// List journals. + /// /// - /// The *List journals* endpoint returns a list of journals for a given company's connection.
+ /// The *List journals* endpoint returns a list of journals for a given company's connection.
///
/// Journals are used to record all the financial transactions of a company.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingJournalsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingJournalsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get journal - /// + /// Get journal. + /// /// /// The *Get journal* endpoint returns a single journal for a given journalId.
///
/// Journals are used to record all the financial transactions of a company.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingJournalRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingJournalRequest request, + RetryConfig? retryConfig = null + ); } public class Journals: IJournals { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Journals(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingJournalsRequest request, RetryConfig? retryConfig = null) + /// + /// List journals. + /// + /// + /// The *List journals* endpoint returns a list of journals for a given company's connection.
+ ///
+ /// Journals are used to record all the financial transactions of a company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingJournalsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountingJourna httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountingJourna throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingJournalRequest request, RetryConfig? retryConfig = null) + + /// + /// Get journal. + /// + /// + /// The *Get journal* endpoint returns a single journal for a given journalId.
+ ///
+ /// Journals are used to record all the financial transactions of a company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingJournalRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingJournalReq httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingJournalReq throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Liabilities.cs b/lending/Codat/Lending/Liabilities.cs index 0aeebed67..1766819e4 100644 --- a/lending/Codat/Lending/Liabilities.cs +++ b/lending/Codat/Lending/Liabilities.cs @@ -27,62 +27,97 @@ namespace Codat.Lending /// public interface ILiabilities { - /// - /// Generate loan transactions report - /// + /// Generate loan transactions report. + /// /// /// The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report.
///
- /// Learn more about Codat's liabilities feature here.
+ /// Learn more about Codat's liabilities feature here.
///
- /// Make sure you have synced a company recently before calling the endpoint.
- /// + /// Make sure you have synced a company recently before calling the endpoint. ///
- /// - Task GenerateLoanTransactionsAsync(GenerateLoanTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GenerateLoanTransactionsAsync( + GenerateLoanTransactionsRequest request, + RetryConfig? retryConfig = null + ); /// - /// List loan transactions - /// + /// List loan transactions. + /// /// - /// The *List loan transactions* endpoint returns all loan transactions identified from a company's accounting, banking, and commerce integrations.
+ /// The *List loan transactions* endpoint returns all loan transactions identified from a company's accounting, banking, and commerce integrations.
///
/// This detail gives analysts a better idea of the loan obligations a company may have.
///
- /// Make sure you have synced a company recently before calling the endpoint.
- /// + /// Make sure you have synced a company recently before calling the endpoint. ///
- /// - Task ListLoanTransactionsAsync(ListLoanTransactionsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListLoanTransactionsAsync( + ListLoanTransactionsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Generate loan summaries report - /// + /// Generate loan summaries report. + /// /// /// The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report.
///
- /// Learn more about Codat's liabilities feature here.
+ /// Learn more about Codat's liabilities feature here.
///
- /// Make sure you have synced a company recently before calling the endpoint.
- /// + /// Make sure you have synced a company recently before calling the endpoint. ///
- /// - Task GenerateLoanSummaryAsync(GenerateLoanSummaryRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GenerateLoanSummaryAsync( + GenerateLoanSummaryRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get loan summaries - /// + /// Get loan summaries. + /// /// - /// The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations.
+ /// The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations.
///
- /// The endpoint returns a list of a company's loan summaries for each valid data connection.
+ /// The endpoint returns a list of a company's loan summaries for each valid data connection.
///
- /// Make sure you have synced a company recently before calling the endpoint.
- /// + /// Make sure you have synced a company recently before calling the endpoint. ///
- /// - Task GetLoanSummaryAsync(GetLoanSummaryRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetLoanSummaryAsync( + GetLoanSummaryRequest request, + RetryConfig? retryConfig = null + ); } /// @@ -90,19 +125,39 @@ public interface ILiabilities /// public class Liabilities: ILiabilities { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Liabilities(SDKConfig config) { SDKConfiguration = config; } - public async Task GenerateLoanTransactionsAsync(GenerateLoanTransactionsRequest request, RetryConfig? retryConfig = null) + /// + /// Generate loan transactions report. + /// + /// + /// The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report.
+ ///
+ /// Learn more about Codat's liabilities feature here.
+ ///
+ /// Make sure you have synced a company recently before calling the endpoint. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GenerateLoanTransactionsAsync( + GenerateLoanTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -162,7 +217,7 @@ public async Task GenerateLoanTransactionsAsyn httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -249,7 +304,29 @@ public async Task GenerateLoanTransactionsAsyn throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListLoanTransactionsAsync(ListLoanTransactionsRequest request, RetryConfig? retryConfig = null) + + /// + /// List loan transactions. + /// + /// + /// The *List loan transactions* endpoint returns all loan transactions identified from a company's accounting, banking, and commerce integrations.
+ ///
+ /// This detail gives analysts a better idea of the loan obligations a company may have.
+ ///
+ /// Make sure you have synced a company recently before calling the endpoint. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListLoanTransactionsAsync( + ListLoanTransactionsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -309,7 +386,7 @@ public async Task ListLoanTransactionsAsync(ListLo httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -414,7 +491,29 @@ public async Task ListLoanTransactionsAsync(ListLo throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GenerateLoanSummaryAsync(GenerateLoanSummaryRequest request, RetryConfig? retryConfig = null) + + /// + /// Generate loan summaries report. + /// + /// + /// The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report.
+ ///
+ /// Learn more about Codat's liabilities feature here.
+ ///
+ /// Make sure you have synced a company recently before calling the endpoint. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GenerateLoanSummaryAsync( + GenerateLoanSummaryRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -474,7 +573,7 @@ public async Task GenerateLoanSummaryAsync(Generate httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -561,7 +660,29 @@ public async Task GenerateLoanSummaryAsync(Generate throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetLoanSummaryAsync(GetLoanSummaryRequest request, RetryConfig? retryConfig = null) + + /// + /// Get loan summaries. + /// + /// + /// The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations.
+ ///
+ /// The endpoint returns a list of a company's loan summaries for each valid data connection.
+ ///
+ /// Make sure you have synced a company recently before calling the endpoint. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetLoanSummaryAsync( + GetLoanSummaryRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -621,7 +742,7 @@ public async Task GetLoanSummaryAsync(GetLoanSummaryRequ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -725,5 +846,6 @@ public async Task GetLoanSummaryAsync(GetLoanSummaryRequ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/LoanWriteback.cs b/lending/Codat/Lending/LoanWriteback.cs index 78251f9c7..11c3658e5 100644 --- a/lending/Codat/Lending/LoanWriteback.cs +++ b/lending/Codat/Lending/LoanWriteback.cs @@ -17,32 +17,84 @@ namespace Codat.Lending public interface ILoanWriteback { public IBankAccounts BankAccounts { get; } + public ICodatLendingLoanWritebackAccounts Accounts { get; } + public ISourceAccounts SourceAccounts { get; } + public ICodatLendingSuppliers Suppliers { get; } + public ICodatLendingTransfers Transfers { get; } + public IBankTransactions BankTransactions { get; } + public ICodatLendingDirectCosts DirectCosts { get; } + public ICodatLendingLoanWritebackPayments Payments { get; } + public ICreateOperations CreateOperations { get; } } public class LoanWriteback: ILoanWriteback { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// BankAccounts SubSDK. + /// + /// public IBankAccounts BankAccounts { get; private set; } + + /// + /// Accounts SubSDK. + /// + /// public ICodatLendingLoanWritebackAccounts Accounts { get; private set; } + + /// + /// SourceAccounts SubSDK. + /// + /// public ISourceAccounts SourceAccounts { get; private set; } + + /// + /// Suppliers SubSDK. + /// + /// public ICodatLendingSuppliers Suppliers { get; private set; } + + /// + /// Transfers SubSDK. + /// + /// public ICodatLendingTransfers Transfers { get; private set; } + + /// + /// BankTransactions SubSDK. + /// + /// public IBankTransactions BankTransactions { get; private set; } + + /// + /// DirectCosts SubSDK. + /// + /// public ICodatLendingDirectCosts DirectCosts { get; private set; } + + /// + /// Payments SubSDK. + /// + /// public ICodatLendingLoanWritebackPayments Payments { get; private set; } + + /// + /// CreateOperations SubSDK. + /// + /// public ICreateOperations CreateOperations { get; private set; } public LoanWriteback(SDKConfig config) diff --git a/lending/Codat/Lending/Locations.cs b/lending/Codat/Lending/Locations.cs index 725070666..684ded218 100644 --- a/lending/Codat/Lending/Locations.cs +++ b/lending/Codat/Lending/Locations.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ILocations { - /// - /// List locations - /// + /// List locations. + /// /// - /// The *List locations* endpoint returns a list of locations for a given company's connection.
+ /// The *List locations* endpoint returns a list of locations for a given company's connection.
///
/// Locations hold information on the geographic location at which stocks of products may be held or where orders were placed.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommerceLocationsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceLocationsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get location - /// + /// Get location. + /// /// /// The *Get location* endpoint returns a single location for a given locationId.
///
/// Locations hold information on the geographic location at which stocks of products may be held or where orders were placed.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommerceLocationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommerceLocationRequest request, + RetryConfig? retryConfig = null + ); } public class Locations: ILocations { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Locations(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceLocationsRequest request, RetryConfig? retryConfig = null) + /// + /// List locations. + /// + /// + /// The *List locations* endpoint returns a list of locations for a given company's connection.
+ ///
+ /// Locations hold information on the geographic location at which stocks of products may be held or where orders were placed.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceLocationsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommerceLocations httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommerceLocations throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceLocationRequest request, RetryConfig? retryConfig = null) + + /// + /// Get location. + /// + /// + /// The *Get location* endpoint returns a single location for a given locationId.
+ ///
+ /// Locations hold information on the geographic location at which stocks of products may be held or where orders were placed.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceLocationRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommerceLocationReque httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommerceLocationReque throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/ManageData.cs b/lending/Codat/Lending/ManageData.cs index 7af71723b..80fbda9dc 100644 --- a/lending/Codat/Lending/ManageData.cs +++ b/lending/Codat/Lending/ManageData.cs @@ -25,27 +25,43 @@ namespace Codat.Lending public interface IManageData { public IRefresh Refresh { get; } - public IPullOperations PullOperations { get; } + public IPullOperations PullOperations { get; } /// - /// Get data status - /// + /// Get data status. + /// /// - /// Get the state of each data type for a company + /// Get the state of each data type for a company. /// - /// - Task GetStatusAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetStatusAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null); } public class ManageData: IManageData { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// Refresh SubSDK. + /// + /// public IRefresh Refresh { get; private set; } + + /// + /// PullOperations SubSDK. + /// + /// public IPullOperations PullOperations { get; private set; } public ManageData(SDKConfig config) @@ -55,7 +71,24 @@ public ManageData(SDKConfig config) PullOperations = new PullOperations(SDKConfiguration); } - public async Task GetStatusAsync(GetDataStatusRequest request, RetryConfig? retryConfig = null) + /// + /// Get data status. + /// + /// + /// Get the state of each data type for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetStatusAsync( + GetDataStatusRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -115,7 +148,7 @@ public async Task GetStatusAsync(GetDataStatusRequest req httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -219,5 +252,6 @@ public async Task GetStatusAsync(GetDataStatusRequest req throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/ManageReports.cs b/lending/Codat/Lending/ManageReports.cs index 182102d74..511a60dc5 100644 --- a/lending/Codat/Lending/ManageReports.cs +++ b/lending/Codat/Lending/ManageReports.cs @@ -27,26 +27,42 @@ namespace Codat.Lending /// public interface IManageReports { - /// - /// Generate report - /// + /// Generate report. + /// /// /// Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter.
///
- /// This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. + /// This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. ///
- /// - Task GenerateReportAsync(GenerateReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GenerateReportAsync( + GenerateReportRequest request, + RetryConfig? retryConfig = null + ); /// - /// List reports - /// + /// List reports. + /// /// - /// Use the *List reports* endpoint to return details (such as generation's current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results. + /// Use the *List reports* endpoint to return details (such as generation's current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results. /// - /// - Task ListReportsAsync(ListReportsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListReportsAsync(ListReportsRequest request, RetryConfig? retryConfig = null); } /// @@ -54,19 +70,37 @@ public interface IManageReports /// public class ManageReports: IManageReports { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public ManageReports(SDKConfig config) { SDKConfiguration = config; } - public async Task GenerateReportAsync(GenerateReportRequest request, RetryConfig? retryConfig = null) + /// + /// Generate report. + /// + /// + /// Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter.
+ ///
+ /// This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GenerateReportAsync( + GenerateReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -126,7 +160,7 @@ public async Task GenerateReportAsync(GenerateReportRequ httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -231,7 +265,25 @@ public async Task GenerateReportAsync(GenerateReportRequ throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListReportsAsync(ListReportsRequest request, RetryConfig? retryConfig = null) + + /// + /// List reports. + /// + /// + /// Use the *List reports* endpoint to return details (such as generation's current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListReportsAsync( + ListReportsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -291,7 +343,7 @@ public async Task ListReportsAsync(ListReportsRequest reque httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -395,5 +447,6 @@ public async Task ListReportsAsync(ListReportsRequest reque throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Metrics.cs b/lending/Codat/Lending/Metrics.cs index caebc9d1b..ab2bd601b 100644 --- a/lending/Codat/Lending/Metrics.cs +++ b/lending/Codat/Lending/Metrics.cs @@ -24,20 +24,19 @@ namespace Codat.Lending public interface IMetrics { - /// - /// Get commerce revenue metrics - /// + /// Get commerce revenue metrics. + /// /// /// The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.
///
- /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
///
/// Learn more about the formulas used to calculate the revenue metrics.
///
/// #### Response structure
///
- /// The Revenue report's dimensions and measures are:
+ /// The Revenue report's dimensions and measures are:
///
/// | Index | Dimensions |
/// |---------------|------------|
@@ -47,21 +46,30 @@ public interface IMetrics /// | Index | Measures |
/// |---------------|--------------------------------------------------------------------------------------------------------------------------|
/// | `index` = 0 | Value |
- /// | `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |
+ /// | `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |
///
- /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
- /// + /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. ///
- /// - Task GetRevenueAsync(GetCommerceRevenueMetricsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetRevenueAsync( + GetCommerceRevenueMetricsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get customer retention metrics - /// + /// Get customer retention metrics. + /// /// - /// The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.
+ /// The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.
///
- /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
///
/// #### Customer retention metrics
///
@@ -75,7 +83,7 @@ public interface IMetrics ///
/// #### Response structure
///
- /// The Customer retention report's dimensions and measures are:
+ /// The Customer retention report's dimensions and measures are:
///
/// | Index | Dimensions |
/// |-----------------------------|----------------------------|
@@ -89,22 +97,32 @@ public interface IMetrics ///
/// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. ///
- /// - Task GetCustomerRetentionAsync(GetCommerceCustomerRetentionMetricsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCustomerRetentionAsync( + GetCommerceCustomerRetentionMetricsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get lifetime value metrics - /// + /// Get lifetime value metrics. + /// /// /// The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time.
///
- /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
///
/// Learn more about the formulas used to calculate the lifetime value metrics.
///
/// #### Response structure
///
- /// The Lifetime value report's dimensions and measures are:
+ /// The Lifetime value report's dimensions and measures are:
///
/// | Index | Dimensions |
/// |---------------|------------------------|
@@ -115,28 +133,73 @@ public interface IMetrics /// |-------------------|---------|
/// | `index` = 1 | Value |
///
- /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
- /// + /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. ///
- /// - Task GetLifetimeValueAsync(GetCommerceLifetimeValueMetricsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetLifetimeValueAsync( + GetCommerceLifetimeValueMetricsRequest request, + RetryConfig? retryConfig = null + ); } public class Metrics: IMetrics { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Metrics(SDKConfig config) { SDKConfiguration = config; } - public async Task GetRevenueAsync(GetCommerceRevenueMetricsRequest request, RetryConfig? retryConfig = null) + /// + /// Get commerce revenue metrics. + /// + /// + /// The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.
+ ///
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ ///
+ /// Learn more about the formulas used to calculate the revenue metrics.
+ ///
+ /// #### Response structure
+ ///
+ /// The Revenue report's dimensions and measures are:
+ ///
+ /// | Index | Dimensions |
+ /// |---------------|------------|
+ /// | `index` = 0 | Period |
+ /// | `index` = 1 | Revenue |
+ ///
+ /// | Index | Measures |
+ /// |---------------|--------------------------------------------------------------------------------------------------------------------------|
+ /// | `index` = 0 | Value |
+ /// | `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |
+ ///
+ /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetRevenueAsync( + GetCommerceRevenueMetricsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -196,7 +259,7 @@ public async Task GetRevenueAsync(GetCommerce httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -301,7 +364,53 @@ public async Task GetRevenueAsync(GetCommerce throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetCustomerRetentionAsync(GetCommerceCustomerRetentionMetricsRequest request, RetryConfig? retryConfig = null) + + /// + /// Get customer retention metrics. + /// + /// + /// The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.
+ ///
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ ///
+ /// #### Customer retention metrics
+ ///
+ /// - __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period.
+ /// - __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period.
+ /// - __Total customers__: the total number of existing and new customers within the specified period.
+ /// - __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage.
+ /// - __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage.
+ ///
+ /// Learn more about the formulas used to calculate customer retention metrics.
+ ///
+ /// #### Response structure
+ ///
+ /// The Customer retention report's dimensions and measures are:
+ ///
+ /// | Index | Dimensions |
+ /// |-----------------------------|----------------------------|
+ /// | `index` = 0 | Period |
+ /// | `index` = 1 | Customer retention metrics |
+ ///
+ /// | Index | Measures |
+ /// |----------------------|------------|
+ /// | `index` = 0 | Count |
+ /// | `index` = 1 | Percentage |
+ ///
+ /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCustomerRetentionAsync( + GetCommerceCustomerRetentionMetricsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -361,7 +470,7 @@ public async Task GetCustomerRetent httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -466,7 +575,44 @@ public async Task GetCustomerRetent throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetLifetimeValueAsync(GetCommerceLifetimeValueMetricsRequest request, RetryConfig? retryConfig = null) + + /// + /// Get lifetime value metrics. + /// + /// + /// The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time.
+ ///
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ ///
+ /// Learn more about the formulas used to calculate the lifetime value metrics.
+ ///
+ /// #### Response structure
+ ///
+ /// The Lifetime value report's dimensions and measures are:
+ ///
+ /// | Index | Dimensions |
+ /// |---------------|------------------------|
+ /// | `index` = 0 | Period |
+ /// | `index` = 1 | Lifetime value metrics |
+ ///
+ /// | Index | Measures |
+ /// |-------------------|---------|
+ /// | `index` = 1 | Value |
+ ///
+ /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetLifetimeValueAsync( + GetCommerceLifetimeValueMetricsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -526,7 +672,7 @@ public async Task GetLifetimeValueAsync httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -630,5 +776,6 @@ public async Task GetLifetimeValueAsync throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountBalance.cs b/lending/Codat/Lending/Models/Components/AccountBalance.cs index 7fd3cdaae..dc9b72c76 100644 --- a/lending/Codat/Lending/Models/Components/AccountBalance.cs +++ b/lending/Codat/Lending/Models/Components/AccountBalance.cs @@ -11,30 +11,29 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountBalance { - /// - /// The account's current balance + /// The account's current balance. /// [JsonProperty("available")] public decimal? Available { get; set; } /// - /// Funds that are not yet available in the balance + /// Funds that are not yet available in the balance. /// [JsonProperty("pending")] public decimal? Pending { get; set; } /// - /// Funds reserved as holdings + /// Funds reserved as holdings. /// [JsonProperty("reserved")] public object? Reserved { get; set; } /// - /// The currency of the account + /// The currency of the account. /// [JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountBalanceAmounts.cs b/lending/Codat/Lending/Models/Components/AccountBalanceAmounts.cs index 77fc4692d..09bc4acb5 100644 --- a/lending/Codat/Lending/Models/Components/AccountBalanceAmounts.cs +++ b/lending/Codat/Lending/Models/Components/AccountBalanceAmounts.cs @@ -11,15 +11,14 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Depending on the data provided by the underlying bank, not all balances are always available. /// public class AccountBalanceAmounts { - /// - /// The balance available in the account, including any pending transactions. This doesn't include additional funds available from any overdrafts. + /// The balance available in the account, including any pending transactions. This doesn't include additional funds available from any overdrafts. /// [JsonProperty("available")] public decimal? Available { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhook.cs b/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhook.cs index 326205908..139e97c9a 100644 --- a/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhook.cs +++ b/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhook.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Webhook request body for the "Account categories updated" event. + /// Webhook request body for the "Account categories updated" event. /// public class AccountCategoriesUpdatedWebhook { - /// /// Unique identifier for your client in Codat. /// @@ -39,7 +38,7 @@ public class AccountCategoriesUpdatedWebhook public string? CompanyId { get; set; } /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("DataConnectionId")] public string? DataConnectionId { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhookData.cs b/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhookData.cs index 3b764b482..13b47ad08 100644 --- a/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhookData.cs +++ b/lending/Codat/Lending/Models/Components/AccountCategoriesUpdatedWebhookData.cs @@ -11,18 +11,14 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountCategoriesUpdatedWebhookData { - /// - /// In Codat's data model, dates are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date fields are formatted as strings; for example:
- /// - /// + /// In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
/// ```
/// 2020-10-08
/// ``` - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/AccountCategoryLevel.cs b/lending/Codat/Lending/Models/Components/AccountCategoryLevel.cs index 8f20f9075..f693d9d9a 100644 --- a/lending/Codat/Lending/Models/Components/AccountCategoryLevel.cs +++ b/lending/Codat/Lending/Models/Components/AccountCategoryLevel.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// An object containing an ordered list of account category levels. /// public class AccountCategoryLevel { - /// /// Account category name. /// diff --git a/lending/Codat/Lending/Models/Components/AccountIdentifierType.cs b/lending/Codat/Lending/Models/Components/AccountIdentifierType.cs index 0d35435ce..6b00efe7a 100644 --- a/lending/Codat/Lending/Models/Components/AccountIdentifierType.cs +++ b/lending/Codat/Lending/Models/Components/AccountIdentifierType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Type of account + /// Type of account. /// public enum AccountIdentifierType { @@ -66,5 +66,4 @@ public static AccountIdentifierType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountIdentifierType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountIdentifiers.cs b/lending/Codat/Lending/Models/Components/AccountIdentifiers.cs index 953f0840a..a8852d4ba 100644 --- a/lending/Codat/Lending/Models/Components/AccountIdentifiers.cs +++ b/lending/Codat/Lending/Models/Components/AccountIdentifiers.cs @@ -12,21 +12,20 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// An object containing bank account identification information. /// public class AccountIdentifiers { - /// - /// Type of account + /// Type of account. /// [JsonProperty("type")] public AccountIdentifierType Type { get; set; } = default!; /// - /// Detailed account category + /// Detailed account category. /// [JsonProperty("subtype")] public string? Subtype { get; set; } = null; @@ -39,14 +38,11 @@ public class AccountIdentifiers /// /// The local (usually national) routing number for the account.
- /// - /// ///
/// This is known by different names in different countries:
/// * BSB code (Australia)
/// * routing number (Canada, USA)
- /// * sort code (UK) - ///
+ /// * sort code (UK). ///
[JsonProperty("bankCode")] public string? BankCode { get; set; } = null; @@ -64,7 +60,7 @@ public class AccountIdentifiers public string? Bic { get; set; } = null; /// - /// A portion of the actual account `number` to help account identification where number is tokenised (Plaid only) + /// A portion of the actual account `number` to help account identification where number is tokenised (Plaid only). /// [JsonProperty("maskedAccountNumber")] public string? MaskedAccountNumber { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/AccountInfo.cs b/lending/Codat/Lending/Models/Components/AccountInfo.cs index 4f3151867..04c181946 100644 --- a/lending/Codat/Lending/Models/Components/AccountInfo.cs +++ b/lending/Codat/Lending/Models/Components/AccountInfo.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountInfo { - /// /// Description of the account. /// @@ -28,13 +27,10 @@ public class AccountInfo public string? Nickname { get; set; } = null; /// - /// In Codat's data model, dates are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date fields are formatted as strings; for example:
- /// - /// + /// In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
/// ```
/// 2020-10-08
/// ``` - ///
///
[JsonProperty("accountOpenDate")] public string? AccountOpenDate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/AccountInstitution.cs b/lending/Codat/Lending/Models/Components/AccountInstitution.cs index 315674eac..1c84e13a8 100644 --- a/lending/Codat/Lending/Models/Components/AccountInstitution.cs +++ b/lending/Codat/Lending/Models/Components/AccountInstitution.cs @@ -11,21 +11,20 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The bank or other financial institution providing the account. /// public class AccountInstitution { - /// - /// The institution's ID, according to the provider. + /// The institution's ID, according to the provider. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// The institution's name, according to the underlying provider. + /// The institution's name, according to the underlying provider. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountPrototype.cs b/lending/Codat/Lending/Models/Components/AccountPrototype.cs index 14abe33e7..c57cbd9b2 100644 --- a/lending/Codat/Lending/Models/Components/AccountPrototype.cs +++ b/lending/Codat/Lending/Models/Components/AccountPrototype.cs @@ -13,12 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountPrototype { - /// - /// 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. + /// 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. /// [JsonProperty("nominalCode")] public string? NominalCode { get; set; } = null; @@ -37,38 +36,29 @@ public class AccountPrototype /// /// 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 guide, or refer to the integration's own documentation. - ///
+ /// 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 guide, or refer to the integration's own documentation. ///
[JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } = null; /// /// Full name of the account, for example:
- /// - /// /// - `Cash On Hand`
/// - `Rents Held In Trust`
/// - `Fixed Asset` - ///
///
[JsonProperty("fullyQualifiedName")] public string? FullyQualifiedName { get; set; } = null; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -80,13 +70,13 @@ public class AccountPrototype public decimal? CurrentBalance { get; set; } = null; /// - /// Type of account + /// Type of account. /// [JsonProperty("type")] public AccountType? Type { get; set; } /// - /// Status of the account + /// Status of the account. /// [JsonProperty("status")] public AccountStatus? Status { get; set; } @@ -105,11 +95,8 @@ public class AccountPrototype /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountPrototypeValidDataTypeLinks.cs b/lending/Codat/Lending/Models/Components/AccountPrototypeValidDataTypeLinks.cs index 1bb4cf9d0..497e1bf84 100644 --- a/lending/Codat/Lending/Models/Components/AccountPrototypeValidDataTypeLinks.cs +++ b/lending/Codat/Lending/Models/Components/AccountPrototypeValidDataTypeLinks.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
- /// - /// + /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
///
/// For example, `validDatatypeLinks` might indicate the following references:
///
@@ -31,18 +29,18 @@ namespace Codat.Lending.Models.Components ///
/// ```json validDatatypeLinks for an account
/// {
- /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
- /// "nominalCode": "090",
- /// "name": "Business Bank Account",
+ /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ /// "nominalCode": "090",
+ /// "name": "Business Bank Account",
/// #...
- /// "validDatatypeLinks": [
+ /// "validDatatypeLinks": [
/// {
- /// "property": "Id",
- /// "links": [
- /// "Payment.AccountRef.Id",
- /// "BillPayment.AccountRef.Id",
- /// "DirectIncome.LineItems.AccountRef.Id",
- /// "DirectCost.LineItems.AccountRef.Id"
+ /// "property": "Id",
+ /// "links": [
+ /// "Payment.AccountRef.Id",
+ /// "BillPayment.AccountRef.Id",
+ /// "DirectIncome.LineItems.AccountRef.Id",
+ /// "DirectCost.LineItems.AccountRef.Id"
/// ]
/// }
/// ]
@@ -55,12 +53,10 @@ namespace Codat.Lending.Models.Components ///
/// Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations.
///
- /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>. - ///
+ /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. ///
public class AccountPrototypeValidDataTypeLinks { - /// /// The property from the account that can be linked. /// diff --git a/lending/Codat/Lending/Models/Components/AccountRef.cs b/lending/Codat/Lending/Models/Components/AccountRef.cs index e738be8ee..643f46269 100644 --- a/lending/Codat/Lending/Models/Components/AccountRef.cs +++ b/lending/Codat/Lending/Models/Components/AccountRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// An account reference containing the account id and name. /// public class AccountRef { - /// /// The id of the account. /// diff --git a/lending/Codat/Lending/Models/Components/AccountStatus.cs b/lending/Codat/Lending/Models/Components/AccountStatus.cs index fee604ffa..ec354bad5 100644 --- a/lending/Codat/Lending/Models/Components/AccountStatus.cs +++ b/lending/Codat/Lending/Models/Components/AccountStatus.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Status of the account + /// Status of the account. /// public enum AccountStatus { @@ -60,5 +60,4 @@ public static AccountStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountTransactionLine.cs b/lending/Codat/Lending/Models/Components/AccountTransactionLine.cs index 4492fbcb0..41ec83a6e 100644 --- a/lending/Codat/Lending/Models/Components/AccountTransactionLine.cs +++ b/lending/Codat/Lending/Models/Components/AccountTransactionLine.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountTransactionLine { - /// /// Description of the account transaction. /// diff --git a/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRef.cs b/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRef.cs index 5fbfacd23..c19802e08 100644 --- a/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRef.cs +++ b/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRef.cs @@ -12,15 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links an account transaction line to the underlying record that created it. /// public class AccountTransactionLineRecordRef { - /// - /// 'id' of the underlying record or data type. + /// 'id' of the underlying record or data type. /// [JsonProperty("id")] public string? Id { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRefDataType.cs b/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRefDataType.cs index 4622e29a7..6a50280a2 100644 --- a/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRefDataType.cs +++ b/lending/Codat/Lending/Models/Components/AccountTransactionLineRecordRefDataType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Name of underlying data type. /// @@ -74,5 +74,4 @@ public static AccountTransactionLineRecordRefDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountTransactionLineRecordRefDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountType.cs b/lending/Codat/Lending/Models/Components/AccountType.cs index f99f4599e..9cfe09fb1 100644 --- a/lending/Codat/Lending/Models/Components/AccountType.cs +++ b/lending/Codat/Lending/Models/Components/AccountType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Type of account + /// Type of account. /// public enum AccountType { @@ -64,5 +64,4 @@ public static AccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingAccount.cs b/lending/Codat/Lending/Models/Components/AccountingAccount.cs index 098d7e073..92ba55642 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAccount.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAccount.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
- /// - /// ///
/// ## Overview
///
@@ -36,18 +34,16 @@ namespace Codat.Lending.Models.Components ///
/// To determine the list of allowed categories for a specific integration, you can:
/// - Follow our Create, update, delete data guide and use the Get create account model.
- /// - Refer to the integration's own documentation.
+ /// - Refer to the integration's own documentation.
///
/// > **Accounts with no category**
/// >
- /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
+ /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
/// >
- /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. - ///
+ /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. ///
public class AccountingAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -61,7 +57,7 @@ public class AccountingAccount public string? Id { get; set; } /// - /// 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. + /// 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. /// [JsonProperty("nominalCode")] public string? NominalCode { get; set; } = null; @@ -80,38 +76,29 @@ public class AccountingAccount /// /// 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 guide, or refer to the integration's own documentation. - ///
+ /// 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 guide, or refer to the integration's own documentation. ///
[JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } = null; /// /// Full name of the account, for example:
- /// - /// /// - `Cash On Hand`
/// - `Rents Held In Trust`
/// - `Fixed Asset` - ///
///
[JsonProperty("fullyQualifiedName")] public string? FullyQualifiedName { get; set; } = null; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -123,13 +110,13 @@ public class AccountingAccount public decimal? CurrentBalance { get; set; } = null; /// - /// Type of account + /// Type of account. /// [JsonProperty("type")] public AccountType? Type { get; set; } /// - /// Status of the account + /// Status of the account. /// [JsonProperty("status")] public AccountStatus? Status { get; set; } @@ -148,11 +135,8 @@ public class AccountingAccount /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingAccountTransaction.cs b/lending/Codat/Lending/Models/Components/AccountingAccountTransaction.cs index a1d7d29cc..568cad4f4 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAccountTransaction.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAccountTransaction.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software. For bank transactions posted within a banking platform, refer to Banking transactions.
- /// - /// ///
/// ## Overview
///
@@ -32,11 +30,9 @@ namespace Codat.Lending.Models.Components /// * Transfers: for example, transferring money between two bank accounts.
///
/// Account transactions is the parent data type of payments, bill payments, direct costs, direct incomes, and transfers. - ///
///
public class AccountingAccountTransaction { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -68,9 +64,7 @@ public class AccountingAccountTransaction public BankAccountRef? BankAccountRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -89,7 +83,6 @@ public class AccountingAccountTransaction /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } @@ -102,27 +95,22 @@ public class AccountingAccountTransaction /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -150,7 +138,6 @@ public class AccountingAccountTransaction /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/AccountingAccountTransactionStatus.cs b/lending/Codat/Lending/Models/Components/AccountingAccountTransactionStatus.cs index d7877c82f..0d404e449 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAccountTransactionStatus.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAccountTransactionStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The status of the account transaction. /// @@ -60,5 +60,4 @@ public static AccountingAccountTransactionStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingAccountTransactionStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingAccountTransactions.cs b/lending/Codat/Lending/Models/Components/AccountingAccountTransactions.cs index 1cb79722b..3019c4e84 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAccountTransactions.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAccountTransactions.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingAccountTransactions { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingAccounts.cs b/lending/Codat/Lending/Models/Components/AccountingAccounts.cs index 11fb6f46a..e1b8e6116 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAccounts.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAccounts.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingAccounts { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingAddress.cs b/lending/Codat/Lending/Models/Components/AccountingAddress.cs index 181310d56..23b11ee58 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAddress.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAddress.cs @@ -12,12 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountingAddress { - /// - /// The type of the address + /// The type of the address. /// [JsonProperty("type")] public AccountingAddressType Type { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/AccountingAddressType.cs b/lending/Codat/Lending/Models/Components/AccountingAddressType.cs index 5a9b76e28..7705dcf72 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAddressType.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAddressType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of the address + /// The type of the address. /// public enum AccountingAddressType { @@ -58,5 +58,4 @@ public static AccountingAddressType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingAddressType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingAgedCreditorReport.cs b/lending/Codat/Lending/Models/Components/AccountingAgedCreditorReport.cs index d3b2cd177..6f13ed8da 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAgedCreditorReport.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAgedCreditorReport.cs @@ -13,13 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// The Aged Creditors report shows the total balance owed by a business to its suppliers over time.
- /// - /// ///
- /// You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.
+ /// You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.
///
/// Total assets or liabilities are grouped into 30-day periods for each supplier, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.
///
@@ -38,26 +36,22 @@ namespace Codat.Lending.Models.Components /// Apart from returning the report via the API as JSON and query, you can also return the Aged Creditors report in the Codat portal.
///
/// 1. In the navigation bar, click **Companies**.
- /// 2. Click the name of the company you want to generate the report for. The company's data page is displayed.
+ /// 2. Click the name of the company you want to generate the report for. The company's data page is displayed.
/// 3. Click the **Accounting** tab then click **Reports**.
/// 4. Select **Aged Creditors**.
/// 5. _(Optional)_ Edit the default reporting parameters.
- /// a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date.
+ /// a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date.
/// b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).
/// b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).
/// 6. To run the report, click **Load aged creditors**.
/// 7. The report is generated and displayed at the bottom of the page.
///
/// The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes. - ///
///
public class AccountingAgedCreditorReport { - /// - /// 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:
- /// - /// + /// 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
@@ -76,15 +70,12 @@ public class AccountingAgedCreditorReport /// >
/// > 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. - ///
///
[JsonProperty("generated")] public string? Generated { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -103,7 +94,6 @@ public class AccountingAgedCreditorReport /// >
/// > 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. - ///
///
[JsonProperty("reportDate")] public string? ReportDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingAgedDebtorReport.cs b/lending/Codat/Lending/Models/Components/AccountingAgedDebtorReport.cs index a99b22bc7..62cab41e1 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAgedDebtorReport.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAgedDebtorReport.cs @@ -13,13 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// The Aged Debtors report shows the total outstanding balance due from customers to the business over time.
- /// - /// ///
- /// You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.
+ /// You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.
///
/// Total assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.
///
@@ -38,26 +36,22 @@ namespace Codat.Lending.Models.Components /// Apart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal.
///
/// 1. In the navigation bar, click **Companies**.
- /// 2. Click the name of the company you want to generate the report for. The company's data page is displayed.
+ /// 2. Click the name of the company you want to generate the report for. The company's data page is displayed.
/// 3. Click the **Accounting** tab then click **Reports**.
/// 4. Select **Aged Debtors**.
/// 5. _(Optional)_ Edit the default reporting parameters.
- /// a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date.
+ /// a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date.
/// b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).
/// b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).
/// 6. To run the report, click **Load aged debtors**.
/// 7. The report is generated and displayed at the bottom of the page.
///
/// The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes. - ///
///
public class AccountingAgedDebtorReport { - /// - /// 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:
- /// - /// + /// 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
@@ -76,15 +70,12 @@ public class AccountingAgedDebtorReport /// >
/// > 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. - ///
///
[JsonProperty("generated")] public string? Generated { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -103,7 +94,6 @@ public class AccountingAgedDebtorReport /// >
/// > 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. - ///
///
[JsonProperty("reportDate")] public string? ReportDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingAttachment.cs b/lending/Codat/Lending/Models/Components/AccountingAttachment.cs index b386fafd0..306ca7510 100644 --- a/lending/Codat/Lending/Models/Components/AccountingAttachment.cs +++ b/lending/Codat/Lending/Models/Components/AccountingAttachment.cs @@ -11,17 +11,15 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.
- /// - /// ///
/// > **Retrieving attachments**
/// >
/// > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.
///
- /// Unlike other data types, Codat doesn't support sync settings for attachments.
+ /// Unlike other data types, Codat doesn't support sync settings for attachments.
///
/// Note that different integrations have different requirements to file size and extension of attachments.
///
@@ -30,13 +28,10 @@ namespace Codat.Lending.Models.Components /// | Xero | 4 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 |
/// | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |
/// | NetSuite | 100 MB | 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". |
- /// - ///
+ /// | 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". | ///
public class AccountingAttachment { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -57,19 +52,14 @@ public class AccountingAttachment /// /// File type of the attachment. This is represented by appending the file type to the IETF standard file naming requirements. For example, for a jpeg file the output is **image/jpeg**.
- /// - /// ///
- /// Supported file types vary per platform. - ///
+ /// Supported file types vary per platform. ///
[JsonProperty("contentType")] public string? ContentType { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -88,7 +78,6 @@ public class AccountingAttachment /// >
/// > 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. - ///
///
[JsonProperty("dateCreated")] public string? DateCreated { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBalanceSheet.cs b/lending/Codat/Lending/Models/Components/AccountingBalanceSheet.cs index 4fb0c320a..29bfdb938 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBalanceSheet.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBalanceSheet.cs @@ -13,13 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## Overview
- /// - /// ///
- /// The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes.
+ /// The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes.
///
/// > **Balance sheet or profit and loss report?**
/// >
@@ -33,22 +31,17 @@ namespace Codat.Lending.Models.Components ///
/// **Want to pull this in a standardised structure?**
/// Our Enhanced Financials endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. - ///
///
public class AccountingBalanceSheet { - /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -60,9 +53,7 @@ public class AccountingBalanceSheet public List Reports { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -81,15 +72,12 @@ public class AccountingBalanceSheet /// >
/// > 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. - ///
///
[JsonProperty("mostRecentAvailableMonth")] public string? MostRecentAvailableMonth { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -108,7 +96,6 @@ public class AccountingBalanceSheet /// >
/// > 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. - ///
///
[JsonProperty("earliestAvailableMonth")] public string? EarliestAvailableMonth { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBankAccount.cs b/lending/Codat/Lending/Models/Components/AccountingBankAccount.cs index 4ff78e480..abb9ad2e8 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBankAccount.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBankAccount.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// > **Accessing Bank Accounts through Banking API**
- /// - /// /// >
/// > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
/// >
@@ -30,11 +28,9 @@ namespace Codat.Lending.Models.Components /// * The name and ID of the account in the accounting software.
/// * The currency and balance of the account.
/// * The sort code and account number. - ///
///
public class AccountingBankAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -55,11 +51,8 @@ public class AccountingBankAccount /// /// 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. - ///
///
[JsonProperty("accountType")] public AccountingBankAccountType? AccountType { get; set; } @@ -72,27 +65,21 @@ public class AccountingBankAccount /// /// 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. - ///
///
[JsonProperty("sortCode")] public string? SortCode { get; set; } = null; /// /// 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. - ///
///
[JsonProperty("accountNumber")] public string? AccountNumber { get; set; } = null; @@ -105,15 +92,12 @@ public class AccountingBankAccount /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -138,11 +122,8 @@ public class AccountingBankAccount /// /// 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`. - ///
///
[JsonProperty("overdraftLimit")] public decimal? OverdraftLimit { get; set; } = null; @@ -158,11 +139,8 @@ public class AccountingBankAccount /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBankAccountType.cs b/lending/Codat/Lending/Models/Components/AccountingBankAccountType.cs index b6a3c5c0f..ed6f68f4b 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBankAccountType.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBankAccountType.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// 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. - ///
///
public enum AccountingBankAccountType { @@ -63,5 +60,4 @@ public static AccountingBankAccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingBankAccountType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingBankAccounts.cs b/lending/Codat/Lending/Models/Components/AccountingBankAccounts.cs index 0f0797917..5b687a8b4 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBankAccounts.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBankAccounts.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingBankAccounts { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBankTransaction.cs b/lending/Codat/Lending/Models/Components/AccountingBankTransaction.cs index 0195c3df7..8e98119a0 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBankTransaction.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBankTransaction.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// > **Accessing Bank Accounts through Banking API**
- /// - /// /// >
/// > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
/// >
@@ -30,11 +28,9 @@ namespace Codat.Lending.Models.Components /// * Amount of the transaction.
/// * Current account balance.
/// * Transaction type, for example, credit, debit, or transfer. - ///
///
public class AccountingBankTransaction { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -54,9 +50,7 @@ public class AccountingBankTransaction public string? AccountId { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -75,7 +69,6 @@ public class AccountingBankTransaction /// >
/// > 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. - ///
///
[JsonProperty("clearedOnDate")] public string? ClearedOnDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBankTransactions.cs b/lending/Codat/Lending/Models/Components/AccountingBankTransactions.cs index 996b19117..78253a288 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBankTransactions.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBankTransactions.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingBankTransactions { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBill.cs b/lending/Codat/Lending/Models/Components/AccountingBill.cs index 45acb0806..dd4f45256 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBill.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBill.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Invoices or bills?**
- /// - /// /// >
/// > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill.
/// >
@@ -31,14 +29,12 @@ namespace Codat.Lending.Models.Components /// * Who the bill was received from — the *supplier*.
/// * What the bill is for — the *line items*.
///
- /// Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*.
+ /// Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*.
///
/// You can find these types of transactions in our Direct costs data model. - ///
///
public class AccountingBill { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -74,27 +70,22 @@ public class AccountingBill /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -122,7 +113,6 @@ public class AccountingBill /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -183,11 +173,8 @@ public class AccountingBill /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBillCreditNote.cs b/lending/Codat/Lending/Models/Components/AccountingBillCreditNote.cs index 494115c86..bc650d6ed 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBillCreditNote.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBillCreditNote.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Bill credit notes or credit notes?**
- /// - /// /// >
/// > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see Credit notes.
///
@@ -31,11 +29,9 @@ namespace Codat.Lending.Models.Components /// * The original and remaining credit.
/// * Any allocations of the credit against other records, such as bills.
/// * The supplier that issued the bill credit note. - ///
///
public class AccountingBillCreditNote { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -64,7 +60,7 @@ public class AccountingBillCreditNote public List? WithholdingTax { get; set; } = null; /// - /// Total amount of credit that has been applied to the business' account with the supplier, including discounts and tax. + /// Total amount of credit that has been applied to the business' account with the supplier, including discounts and tax. /// [JsonProperty("totalAmount")] public decimal TotalAmount { get; set; } = default!; @@ -100,15 +96,13 @@ public class AccountingBillCreditNote public decimal? RemainingCredit { get; set; } /// - /// Current state of the bill credit note + /// Current state of the bill credit note. /// [JsonProperty("status")] public BillCreditNoteStatus Status { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -127,15 +121,12 @@ public class AccountingBillCreditNote /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string? IssueDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -154,34 +145,28 @@ public class AccountingBillCreditNote /// >
/// > 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. - ///
///
[JsonProperty("allocatedOnDate")] public string? AllocatedOnDate { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -209,13 +194,12 @@ public class AccountingBillCreditNote /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; /// - /// An array of line + /// An array of line. /// [JsonProperty("lineItems")] public List? LineItems { get; set; } = null; @@ -240,11 +224,8 @@ public class AccountingBillCreditNote /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBillCreditNotes.cs b/lending/Codat/Lending/Models/Components/AccountingBillCreditNotes.cs index eeb50d519..7726dcb05 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBillCreditNotes.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBillCreditNotes.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingBillCreditNotes { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBillPayment.cs b/lending/Codat/Lending/Models/Components/AccountingBillPayment.cs index c5e9aaf88..6671864aa 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBillPayment.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBillPayment.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Bill payments or payments?**
- /// - /// /// >
/// > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.
/// >
@@ -30,7 +28,7 @@ namespace Codat.Lending.Models.Components /// A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:
///
/// - A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment.
- /// - An allocation of a supplier's credit note to a bill or perhaps a refund.
+ /// - An allocation of a supplier's credit note to a bill or perhaps a refund.
/// - A bill payment made directly to an accounts payable account. This could be an overpayment or a prepayment, or a refund of a payment made directly to an accounts payable account.
///
/// Depending on the bill payments which are allowed by the underlying accounting software, some of these types may be combined. Please see the example data section for samples of what these cases look like.
@@ -42,7 +40,7 @@ namespace Codat.Lending.Models.Components /// - Who the payment has been paid to, the _supplier_.
/// - The types of bill payments, the _line items_.
///
- /// Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our Direct costs data model.
+ /// Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our Direct costs data model.
///
/// Bill payments is a child data type of account transactions.
///
@@ -113,7 +111,7 @@ namespace Codat.Lending.Models.Components /// - A **type** indicating the type of `link`, in this case a `CreditNote`.
/// - An **id** containing the ID of the credit note that was refunded.
///
- /// The **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable.
+ /// The **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable.
///
/// ### Refunding a payment
///
@@ -164,13 +162,10 @@ namespace Codat.Lending.Models.Components /// These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a bill payment is applied to an item in a currency that does not match either:
///
/// - The base currency for the accounts payable account.
- /// - The currency of the item.
- /// - ///
+ /// - The currency of the item. ///
public class AccountingBillPayment { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -193,7 +188,7 @@ public class AccountingBillPayment public AccountRef? AccountRef { get; set; } /// - /// Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. + /// Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. /// [JsonProperty("totalAmount")] public decimal? TotalAmount { get; set; } @@ -203,12 +198,10 @@ public class AccountingBillPayment /// /// 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.
+ /// 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).
///
@@ -236,7 +229,6 @@ public class AccountingBillPayment /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -270,11 +262,8 @@ public class AccountingBillPayment /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBillPayments.cs b/lending/Codat/Lending/Models/Components/AccountingBillPayments.cs index 2f389e372..bd3b2f4fb 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBillPayments.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBillPayments.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingBillPayments { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingBills.cs b/lending/Codat/Lending/Models/Components/AccountingBills.cs index 01c9247e6..94434d983 100644 --- a/lending/Codat/Lending/Models/Components/AccountingBills.cs +++ b/lending/Codat/Lending/Models/Components/AccountingBills.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingBills { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCashFlowStatement.cs b/lending/Codat/Lending/Models/Components/AccountingCashFlowStatement.cs index 270c183cb..bdefa0cc9 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCashFlowStatement.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCashFlowStatement.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Operating activities only**
- /// - /// /// >
/// > Currently, the cash flow statement shows cash that flows into and out of the company from operating activities *only*. Operating activities generate cash from the sale of goods or services.
///
@@ -27,12 +25,10 @@ namespace Codat.Lending.Models.Components ///
/// > **Cash flow statement or balance sheet?**
/// >
- /// > Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees. - ///
+ /// > Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees. ///
public class AccountingCashFlowStatement { - /// /// Array of cash flow statements. /// @@ -53,23 +49,18 @@ public class AccountingCashFlowStatement /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -88,15 +79,12 @@ public class AccountingCashFlowStatement /// >
/// > 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. - ///
///
[JsonProperty("mostRecentAvailableMonth")] public string? MostRecentAvailableMonth { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -115,7 +103,6 @@ public class AccountingCashFlowStatement /// >
/// > 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. - ///
///
[JsonProperty("earliestAvailableMonth")] public string? EarliestAvailableMonth { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCompanyInfo.cs b/lending/Codat/Lending/Models/Components/AccountingCompanyInfo.cs index b2f297ba6..415d6ffcc 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCompanyInfo.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCompanyInfo.cs @@ -13,20 +13,16 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// 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 AccountingCompanyInfo { - /// /// Name of the linked company. /// @@ -64,9 +60,7 @@ public class AccountingCompanyInfo public List? WebLinks { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -85,7 +79,6 @@ public class AccountingCompanyInfo /// >
/// > 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. - ///
///
[JsonProperty("ledgerLockDate")] public string? LedgerLockDate { get; set; } @@ -103,9 +96,7 @@ public class AccountingCompanyInfo public string? TaxNumber { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -124,7 +115,6 @@ public class AccountingCompanyInfo /// >
/// > 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. - ///
///
[JsonProperty("financialYearStartDate")] public string? FinancialYearStartDate { get; set; } @@ -137,19 +127,14 @@ public class AccountingCompanyInfo /// /// 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. - ///
///
[JsonProperty("sourceUrls")] public Dictionary? SourceUrls { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -168,18 +153,14 @@ public class AccountingCompanyInfo /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponse.cs index 40afe3c42..20861776c 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreateAccountResponse { - [JsonProperty("data")] public AccountingCreateAccountResponseAccountingAccount? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreateAccountResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreateAccountResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreateAccountResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseAccountingAccount.cs b/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseAccountingAccount.cs index 1121638ff..e6d4cfe7f 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseAccountingAccount.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseAccountingAccount.cs @@ -14,11 +14,9 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + /// /// > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
- /// - /// ///
/// ## Overview
///
@@ -37,19 +35,17 @@ namespace Codat.Lending.Models.Components ///
/// To determine the list of allowed categories for a specific integration, you can:
/// - Follow our Create, update, delete data guide and use the Get create account model.
- /// - Refer to the integration's own documentation.
+ /// - Refer to the integration's own documentation.
///
/// > **Accounts with no category**
/// >
- /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
+ /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
/// >
- /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. - ///
+ /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. ///
[Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreateAccountResponseAccountingAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -63,7 +59,7 @@ public class AccountingCreateAccountResponseAccountingAccount public string? Id { get; set; } /// - /// 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. + /// 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. /// [JsonProperty("nominalCode")] public string? NominalCode { get; set; } = null; @@ -82,38 +78,29 @@ public class AccountingCreateAccountResponseAccountingAccount /// /// 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 guide, or refer to the integration's own documentation. - ///
+ /// 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 guide, or refer to the integration's own documentation. ///
[JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } = null; /// /// Full name of the account, for example:
- /// - /// /// - `Cash On Hand`
/// - `Rents Held In Trust`
/// - `Fixed Asset` - ///
///
[JsonProperty("fullyQualifiedName")] public string? FullyQualifiedName { get; set; } = null; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -125,13 +112,13 @@ public class AccountingCreateAccountResponseAccountingAccount public decimal? CurrentBalance { get; set; } = null; /// - /// Type of account + /// Type of account. /// [JsonProperty("type")] public AccountType? Type { get; set; } /// - /// Status of the account + /// Status of the account. /// [JsonProperty("status")] public AccountStatus? Status { get; set; } @@ -150,11 +137,8 @@ public class AccountingCreateAccountResponseAccountingAccount /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseValidDataTypeLinks.cs b/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseValidDataTypeLinks.cs index 979022c82..df3770232 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseValidDataTypeLinks.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateAccountResponseValidDataTypeLinks.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
- /// - /// + /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
///
/// For example, `validDatatypeLinks` might indicate the following references:
///
@@ -31,18 +29,18 @@ namespace Codat.Lending.Models.Components ///
/// ```json validDatatypeLinks for an account
/// {
- /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
- /// "nominalCode": "090",
- /// "name": "Business Bank Account",
+ /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ /// "nominalCode": "090",
+ /// "name": "Business Bank Account",
/// #...
- /// "validDatatypeLinks": [
+ /// "validDatatypeLinks": [
/// {
- /// "property": "Id",
- /// "links": [
- /// "Payment.AccountRef.Id",
- /// "BillPayment.AccountRef.Id",
- /// "DirectIncome.LineItems.AccountRef.Id",
- /// "DirectCost.LineItems.AccountRef.Id"
+ /// "property": "Id",
+ /// "links": [
+ /// "Payment.AccountRef.Id",
+ /// "BillPayment.AccountRef.Id",
+ /// "DirectIncome.LineItems.AccountRef.Id",
+ /// "DirectCost.LineItems.AccountRef.Id"
/// ]
/// }
/// ]
@@ -55,12 +53,10 @@ namespace Codat.Lending.Models.Components ///
/// Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations.
///
- /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>. - ///
+ /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. ///
public class AccountingCreateAccountResponseValidDataTypeLinks { - /// /// The property from the account that can be linked. /// diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponse.cs index ea585bf39..0f7b79d62 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreateBankAccountResponse { - [JsonProperty("data")] public AccountingCreateBankAccountResponseAccountingBankAccount? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreateBankAccountResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreateBankAccountResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreateBankAccountResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.cs b/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.cs index c2704f971..4c21ff130 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// > **Accessing Bank Accounts through Banking API**
- /// - /// /// >
/// > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
/// >
@@ -31,12 +29,10 @@ namespace Codat.Lending.Models.Components /// * The name and ID of the account in the accounting software.
/// * The currency and balance of the account.
/// * The sort code and account number. - ///
///
[Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreateBankAccountResponseAccountingBankAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -57,11 +53,8 @@ public class AccountingCreateBankAccountResponseAccountingBankAccount /// /// 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. - ///
///
[JsonProperty("accountType")] public AccountingBankAccountType? AccountType { get; set; } @@ -74,27 +67,21 @@ public class AccountingCreateBankAccountResponseAccountingBankAccount /// /// 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. - ///
///
[JsonProperty("sortCode")] public string? SortCode { get; set; } = null; /// /// 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. - ///
///
[JsonProperty("accountNumber")] public string? AccountNumber { get; set; } = null; @@ -107,15 +94,12 @@ public class AccountingCreateBankAccountResponseAccountingBankAccount /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -140,11 +124,8 @@ public class AccountingCreateBankAccountResponseAccountingBankAccount /// /// 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`. - ///
///
[JsonProperty("overdraftLimit")] public decimal? OverdraftLimit { get; set; } = null; @@ -160,11 +141,8 @@ public class AccountingCreateBankAccountResponseAccountingBankAccount /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountTransactions.cs b/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountTransactions.cs index 1268a7000..353a1b006 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountTransactions.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateBankAccountTransactions.cs @@ -14,11 +14,10 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreateBankAccountTransactions { - /// /// Unique identifier for a bank account. /// diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactions.cs b/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactions.cs index 0cdbd6b1b..4f0e0830a 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactions.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactions.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingCreateBankTransactions { - /// /// Unique identifier for a bank account. /// diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactionsResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactionsResponse.cs index e6212797f..0773c7367 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateBankTransactionsResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreateBankTransactionsResponse { - [JsonProperty("data")] public AccountingCreateBankAccountTransactions? Data { get; set; } /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreateBankTransactionsResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreateBankTransactionsResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreateBankTransactionsResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponse.cs index 97321b17e..e5d8330d1 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreateDirectCostResponse { - [JsonProperty("data")] public AccountingCreateDirectCostResponseAccountingDirectCost? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreateDirectCostResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreateDirectCostResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreateDirectCostResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.cs b/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.cs index 05939663a..9c53ddf4f 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.cs @@ -14,11 +14,9 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + /// /// > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software.
- /// - /// ///
/// ## Overview
///
@@ -29,12 +27,10 @@ namespace Codat.Lending.Models.Components /// * Receiving cash from a refunded item if the refund is made by the supplier
///
/// Direct costs is a child data type of account transactions. - ///
///
[Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreateDirectCostResponseAccountingDirectCost { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -63,9 +59,7 @@ public class AccountingCreateDirectCostResponseAccountingDirectCost public ContactRef? ContactRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -84,34 +78,28 @@ public class AccountingCreateDirectCostResponseAccountingDirectCost /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; /// /// 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.
+ /// 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).
///
@@ -139,7 +127,6 @@ public class AccountingCreateDirectCostResponseAccountingDirectCost /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -176,11 +163,8 @@ public class AccountingCreateDirectCostResponseAccountingDirectCost /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponse.cs index 9ecb6d841..2326d69ee 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreatePaymentResponse { - [JsonProperty("data")] public AccountingCreatePaymentResponseAccountingPayment? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreatePaymentResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreatePaymentResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreatePaymentResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponseAccountingPayment.cs b/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponseAccountingPayment.cs index 0549e41b4..4c4a7860a 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponseAccountingPayment.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreatePaymentResponseAccountingPayment.cs @@ -14,11 +14,9 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + /// /// > **Payments or bill payments?**
- /// - /// /// >
/// > In Codat, payments represent accounts receivable only. For accounts payable, see bill payments. These include bills and credit notes against bills.
///
@@ -29,7 +27,7 @@ namespace Codat.Lending.Models.Components /// A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:
///
/// - A payment made against an invoice, like a credit card, cheque, or cash payment.
- /// - An allocation of a customer's credit note, either to an invoice or maybe a refund.
+ /// - An allocation of a customer's credit note, either to an invoice or maybe a refund.
/// - A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.
///
/// Depending on the payments allowed by the underlying accounting software, some payment types may be combined. Please see the example for more details.
@@ -130,7 +128,7 @@ namespace Codat.Lending.Models.Components ///
/// The **line** linked to the payment has the following properties:
///
- /// - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
+ /// - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
/// - A **links** array containing one element with the following properties:
/// - A **type** that indicates the type of **link**, in this case a `Refund`.
/// - An **id** that contains the ID of the payment that refunded this line.
@@ -153,26 +151,26 @@ namespace Codat.Lending.Models.Components /// - Base currency of the item the link represents.
/// - Foreign currency of the payment.
///
- /// These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:
+ /// These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:
///
/// - The base currency for the accounts receivable account.
/// - The currency of the item.
///
- /// ```json title="Currency rate example"
+ /// ```json title="Currency rate example"
/// {
- /// "id": "123",
- /// "note": "",
- /// "totalAmount": 99.99,
- /// "currency": "GBP",
- /// "lines": [
+ /// "id": "123",
+ /// "note": "",
+ /// "totalAmount": 99.99,
+ /// "currency": "GBP",
+ /// "lines": [
/// {
- /// "amount": 99.99,
- /// "links": [
+ /// "amount": 99.99,
+ /// "links": [
/// {
- /// "type": "Invoice",
- /// "id": "178",
- /// "amount": -50,
- /// "currencyRate": 1.9998
+ /// "type": "Invoice",
+ /// "id": "178",
+ /// "amount": -50,
+ /// "currencyRate": 1.9998
/// }
/// ]
/// }
@@ -190,17 +188,17 @@ namespace Codat.Lending.Models.Components ///
/// ## Simple examples
///
- /// ```json title="Payment for invoice"
+ /// ```json title="Payment for invoice"
/// {
- /// "totalAmount": 1000,
- /// "lines": [
+ /// "totalAmount": 1000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -210,22 +208,22 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Allocation of credit note"
+ /// ```json title="Allocation of credit note"
/// {
- /// "totalAmount": 0,
- /// "lines": [
+ /// "totalAmount": 0,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -235,27 +233,27 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Payment of invoice and payment on account"
+ /// ```json title="Payment of invoice and payment on account"
/// {
- /// "totalAmount": 2000,
- /// "lines": [
+ /// "totalAmount": 2000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "y",
- /// "amount" : -1000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "y",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -265,17 +263,17 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Refund of credit note"
+ /// ```json title="Refund of credit note"
/// {
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -285,17 +283,17 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Refund on accounts receivable account"
+ /// ```json title="Refund on accounts receivable account"
/// {
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -305,34 +303,34 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Linked refund on accounts receivable account"
+ /// ```json title="Linked refund on accounts receivable account"
/// {
- /// "id" : "payment-001",
- /// "totalAmount": 1000,
- /// "lines": [
+ /// "id" : "payment-001",
+ /// "totalAmount": 1000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Refund",
- /// "id" : "refund-001",
- /// "amount" : -1000
+ /// "type" : "Refund",
+ /// "id" : "refund-001",
+ /// "amount" : -1000
/// }
/// ]
/// }
/// ]
/// }
/// {
- /// "id" : "refund-001",
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "id" : "refund-001",
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "Payment",
- /// "id" : "payment-001",
- /// "amount" : 1000
+ /// "type" : "Payment",
+ /// "id" : "payment-001",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -342,32 +340,32 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Using a credit note and cash to pay an invoice"
+ /// ```json title="Using a credit note and cash to pay an invoice"
/// {
- /// "totalAmount": 250,
- /// "lines": [
+ /// "totalAmount": 250,
+ /// "lines": [
/// {
- /// "amount": 0,
- /// "links": [
+ /// "amount": 0,
+ /// "links": [
/// {
- /// "type": "Invoice",
- /// "id": "x",
- /// "amount": -750
+ /// "type": "Invoice",
+ /// "id": "x",
+ /// "amount": -750
/// },
/// {
- /// "type": "CreditNote",
- /// "id": "y",
- /// "amount": 750
+ /// "type": "CreditNote",
+ /// "id": "y",
+ /// "amount": 750
/// }
/// ]
/// },
/// {
- /// "amount": 250,
- /// "links": [
+ /// "amount": 250,
+ /// "links": [
/// {
- /// "type": "Invoice",
- /// "id": "x",
- /// "amount": -250
+ /// "type": "Invoice",
+ /// "id": "x",
+ /// "amount": -250
/// }
/// ]
/// }
@@ -379,47 +377,47 @@ namespace Codat.Lending.Models.Components ///
/// ## Complex examples
///
- /// ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
+ /// ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
/// {
- /// "totalAmount": 1000,
- /// "lines": [
+ /// "totalAmount": 1000,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -429,57 +427,57 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
+ /// ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
/// {
- /// "totalAmount": 2000,
- /// "lines": [
+ /// "totalAmount": 2000,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "customer-001",
- /// "amount" : -1000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "customer-001",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -489,32 +487,32 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Two credit notes pay two invoices with no allocation amount specified"
+ /// ```json title="Two credit notes pay two invoices with no allocation amount specified"
/// {
- /// "totalAmount": 0,
- /// "lines": [
+ /// "totalAmount": 0,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "w",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "w",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -524,63 +522,63 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
+ /// ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
/// {
- /// "totalAmount": 2000,
- /// "lines": [
+ /// "totalAmount": 2000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "w",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "w",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "Invoice",
- /// "id" : "u",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "u",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Refund",
- /// "id" : "refund-001",
- /// "amount" : -1000
+ /// "type" : "Refund",
+ /// "id" : "refund-001",
+ /// "amount" : -1000
/// }
/// ]
/// }
/// ]
/// }
/// {
- /// "id" : "refund-001",
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "id" : "refund-001",
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "Payment",
- /// "id" : "payment-001",
- /// "amount" : 1000
+ /// "type" : "Payment",
+ /// "id" : "payment-001",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -592,29 +590,29 @@ namespace Codat.Lending.Models.Components ///
/// In this example, a payment on account is used to pay the same invoice in January and again in February.
///
- /// ```json title="January"
+ /// ```json title="January"
/// {
- /// "id": "001",
- /// "totalAmount": 5000,
- /// "date" : "1901-01-01",
- /// "lines": [
+ /// "id": "001",
+ /// "totalAmount": 5000,
+ /// "date" : "1901-01-01",
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "Invoice-x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "Invoice-x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 4000,
- /// "links" : [
+ /// "amount" : 4000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "PaymentOnAccount-y",
- /// "amount" : -4000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "PaymentOnAccount-y",
+ /// "amount" : -4000
/// }
/// ]
/// }
@@ -624,39 +622,39 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="February"
+ /// ```json title="February"
/// {
- /// "id": "001",
- /// "totalAmount": 5000,
- /// "date" : "1901-02-01",
- /// "lines": [
+ /// "id": "001",
+ /// "totalAmount": 5000,
+ /// "date" : "1901-02-01",
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "Invoice-x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "Invoice-x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "Invoice-y",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "Invoice-y",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 3000,
- /// "links" : [
+ /// "amount" : 3000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "PaymentOnAccount-y",
- /// "amount" : -3000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "PaymentOnAccount-y",
+ /// "amount" : -3000
/// }
/// ]
/// }
@@ -666,40 +664,38 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Two credit notes and some cash pay two invoices with no allocations specified"
+ /// ```json title="Two credit notes and some cash pay two invoices with no allocations specified"
/// {
- /// "totalAmount": 500,
- /// "lines": [
+ /// "totalAmount": 500,
+ /// "lines": [
/// {
- /// "amount": 500,
- /// "links": [{
- /// "type": "Invoice",
- /// "id": "a",
- /// "amount": -1000
+ /// "amount": 500,
+ /// "links": [{
+ /// "type": "Invoice",
+ /// "id": "a",
+ /// "amount": -1000
/// }, {
- /// "type": "Invoice",
- /// "id": "b",
- /// "amount": -1000
+ /// "type": "Invoice",
+ /// "id": "b",
+ /// "amount": -1000
/// }, {
- /// "type": "CreditNote",
- /// "id": "y",
- /// "amount": 750
+ /// "type": "CreditNote",
+ /// "id": "y",
+ /// "amount": 750
/// },{
- /// "type": "CreditNote",
- /// "id": "z",
- /// "amount": 750
+ /// "type": "CreditNote",
+ /// "id": "z",
+ /// "amount": 750
/// }
/// ]
/// }
/// ]
/// }
/// ``` - ///
///
[Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreatePaymentResponseAccountingPayment { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -728,34 +724,29 @@ public class AccountingCreatePaymentResponseAccountingPayment public PaymentMethodRef? PaymentMethodRef { get; set; } /// - /// Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. + /// Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. /// [JsonProperty("totalAmount")] public decimal? TotalAmount { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -783,15 +774,12 @@ public class AccountingCreatePaymentResponseAccountingPayment /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -810,7 +798,6 @@ public class AccountingCreatePaymentResponseAccountingPayment /// >
/// > 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. - ///
///
[JsonProperty("date")] public string Date { get; set; } = default!; @@ -838,11 +825,8 @@ public class AccountingCreatePaymentResponseAccountingPayment /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponse.cs index 519864635..31c99ce7c 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreateSupplierResponse { - [JsonProperty("data")] public AccountingCreateSupplierResponseAccountingSupplier? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreateSupplierResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreateSupplierResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreateSupplierResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.cs b/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.cs index 110a4a3d0..a8f18dbbe 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.cs @@ -14,19 +14,15 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + /// /// ## Overview
- /// - /// ///
- /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. - ///
+ /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. ///
[Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreateSupplierResponseAccountingSupplier { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -76,7 +72,7 @@ public class AccountingCreateSupplierResponseAccountingSupplier public string? RegistrationNumber { get; set; } = null; /// - /// Supplier's company tax number. + /// Supplier's company tax number. /// [JsonProperty("taxNumber")] public string? TaxNumber { get; set; } = null; @@ -88,7 +84,7 @@ public class AccountingCreateSupplierResponseAccountingSupplier public SupplierStatus Status { get; set; } = default!; /// - /// Default currency the supplier's transactional data is recorded in. + /// Default currency the supplier's transactional data is recorded in. /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } = null; @@ -98,11 +94,8 @@ public class AccountingCreateSupplierResponseAccountingSupplier /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponse.cs b/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponse.cs index 5d6c761d2..2cac09dd9 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponse.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponse.cs @@ -14,21 +14,20 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class AccountingCreateTransferResponse { - [JsonProperty("data")] public AccountingCreateTransferResponseAccountingTransfer? Data { get; set; } = null; /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -46,15 +45,13 @@ public class AccountingCreateTransferResponse public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +70,12 @@ public class AccountingCreateTransferResponse /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +94,6 @@ public class AccountingCreateTransferResponse /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseAccountingTransfer.cs b/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseAccountingTransfer.cs index 565008311..5ade55e47 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseAccountingTransfer.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseAccountingTransfer.cs @@ -14,14 +14,13 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + /// /// A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of account transactions. /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class AccountingCreateTransferResponseAccountingTransfer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -44,9 +43,7 @@ public class AccountingCreateTransferResponseAccountingTransfer public ContactRef? ContactRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -65,7 +62,6 @@ public class AccountingCreateTransferResponseAccountingTransfer /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } @@ -83,7 +79,7 @@ public class AccountingCreateTransferResponseAccountingTransfer public TransferAccount? To { get; set; } /// - /// The status of the transfer in the account + /// The status of the transfer in the account. /// [JsonProperty("status")] public AccountingCreateTransferResponseStatus? Status { get; set; } = null; @@ -105,11 +101,8 @@ public class AccountingCreateTransferResponseAccountingTransfer /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseStatus.cs b/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseStatus.cs index d7dcbe582..2adb694ce 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseStatus.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreateTransferResponseStatus.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// The status of the transfer in the account + /// The status of the transfer in the account. /// public enum AccountingCreateTransferResponseStatus { @@ -60,5 +60,4 @@ public static AccountingCreateTransferResponseStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingCreateTransferResponseStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingCreditNote.cs b/lending/Codat/Lending/Models/Components/AccountingCreditNote.cs index aff56c93f..50fa320fa 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreditNote.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreditNote.cs @@ -13,25 +13,21 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## Overview
- /// - /// ///
/// Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.
///
- /// In the Codat system a credit note is issued to a customer's accounts receivable.
+ /// In the Codat system a credit note is issued to a customer's accounts receivable.
///
/// It contains details of:
/// * The amount of credit remaining and its status.
/// * Payment allocations against the payments type, in this case an invoice.
/// * Which customers the credit notes have been issued to. - ///
///
public class AccountingCreditNote { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -57,7 +53,7 @@ public class AccountingCreditNote public List? WithholdingTax { get; set; } = null; /// - /// Total amount of credit that has been applied to the customer's accounts receivable + /// Total amount of credit that has been applied to the customer's accounts receivable. /// [JsonProperty("totalAmount")] public decimal TotalAmount { get; set; } = default!; @@ -111,9 +107,7 @@ public class AccountingCreditNote public CreditNoteStatus Status { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -132,15 +126,12 @@ public class AccountingCreditNote /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string? IssueDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -159,34 +150,28 @@ public class AccountingCreditNote /// >
/// > 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. - ///
///
[JsonProperty("allocatedOnDate")] public string? AllocatedOnDate { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -214,7 +199,6 @@ public class AccountingCreditNote /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -239,11 +223,8 @@ public class AccountingCreditNote /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCreditNotes.cs b/lending/Codat/Lending/Models/Components/AccountingCreditNotes.cs index 77bd1ee33..94877da5e 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCreditNotes.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCreditNotes.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingCreditNotes { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCustomer.cs b/lending/Codat/Lending/Models/Components/AccountingCustomer.cs index 1184c7b0f..46a31d366 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCustomer.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCustomer.cs @@ -13,21 +13,16 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## 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.
///
- /// Customers' data links to accounts receivable invoices.
- /// - ///
+ /// Customers' data links to accounts receivable invoices. ///
public class AccountingCustomer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -60,15 +55,12 @@ public class AccountingCustomer /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } @@ -114,11 +106,8 @@ public class AccountingCustomer /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingCustomerRef.cs b/lending/Codat/Lending/Models/Components/AccountingCustomerRef.cs index 029af59b9..744a1c1e9 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCustomerRef.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCustomerRef.cs @@ -11,18 +11,17 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountingCustomerRef { - /// - /// `id` from the Customers data type + /// `id` from the Customers data type. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// `customerName` from the Customer data type + /// `customerName` from the Customer data type. /// [JsonProperty("companyName")] public string? CompanyName { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/AccountingCustomers.cs b/lending/Codat/Lending/Models/Components/AccountingCustomers.cs index 0e3660ec8..b11b5b1d0 100644 --- a/lending/Codat/Lending/Models/Components/AccountingCustomers.cs +++ b/lending/Codat/Lending/Models/Components/AccountingCustomers.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingCustomers { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingDirectCost.cs b/lending/Codat/Lending/Models/Components/AccountingDirectCost.cs index 92859f20c..106decf97 100644 --- a/lending/Codat/Lending/Models/Components/AccountingDirectCost.cs +++ b/lending/Codat/Lending/Models/Components/AccountingDirectCost.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software.
- /// - /// ///
/// ## Overview
///
@@ -28,11 +26,9 @@ namespace Codat.Lending.Models.Components /// * Receiving cash from a refunded item if the refund is made by the supplier
///
/// Direct costs is a child data type of account transactions. - ///
///
public class AccountingDirectCost { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -61,9 +57,7 @@ public class AccountingDirectCost public ContactRef? ContactRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -82,34 +76,28 @@ public class AccountingDirectCost /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; /// /// 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.
+ /// 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).
///
@@ -137,7 +125,6 @@ public class AccountingDirectCost /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -174,11 +161,8 @@ public class AccountingDirectCost /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingDirectCosts.cs b/lending/Codat/Lending/Models/Components/AccountingDirectCosts.cs index 1ec6b573a..2a5945479 100644 --- a/lending/Codat/Lending/Models/Components/AccountingDirectCosts.cs +++ b/lending/Codat/Lending/Models/Components/AccountingDirectCosts.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingDirectCosts { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingDirectIncome.cs b/lending/Codat/Lending/Models/Components/AccountingDirectIncome.cs index af2f1ac39..cc1a50063 100644 --- a/lending/Codat/Lending/Models/Components/AccountingDirectIncome.cs +++ b/lending/Codat/Lending/Models/Components/AccountingDirectIncome.cs @@ -13,28 +13,23 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software.
- /// - /// ///
/// ## Overview
///
- /// Direct incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes made at the point of sale.
+ /// Direct incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes made at the point of sale.
///
/// Direct incomes include:
///
/// - Selling an item directly to a contact, and receiving payment at the point of the sale.
/// - Refunding an item sold at the point of sale in cash to a contact.
///
- /// Direct incomes is a child data type of account transactions.
- /// - ///
+ /// Direct incomes is a child data type of account transactions. ///
public class AccountingDirectIncome { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -63,9 +58,7 @@ public class AccountingDirectIncome public ContactRef? ContactRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -84,34 +77,28 @@ public class AccountingDirectIncome /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; /// /// 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.
+ /// 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).
///
@@ -139,7 +126,6 @@ public class AccountingDirectIncome /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -176,11 +162,8 @@ public class AccountingDirectIncome /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingDirectIncomes.cs b/lending/Codat/Lending/Models/Components/AccountingDirectIncomes.cs index 54b532758..818817c13 100644 --- a/lending/Codat/Lending/Models/Components/AccountingDirectIncomes.cs +++ b/lending/Codat/Lending/Models/Components/AccountingDirectIncomes.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingDirectIncomes { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingInvoice.cs b/lending/Codat/Lending/Models/Components/AccountingInvoice.cs index 123529262..a7f2a4d32 100644 --- a/lending/Codat/Lending/Models/Components/AccountingInvoice.cs +++ b/lending/Codat/Lending/Models/Components/AccountingInvoice.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Invoices or bills?**
- /// - /// /// >
/// > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.
/// >
@@ -37,18 +35,16 @@ namespace Codat.Lending.Models.Components ///
/// > **Invoice PDF downloads**
/// >
- /// > You can <a className="external" href="https://docs.codat.io/lending-api#/operations/get-invoice-pdf" target="_blank">download a PDF version</a> of an invoice for supported integrations.
+ /// > You can download a PDF version of an invoice for supported integrations.
/// >
/// > The filename will be invoice-{number}.pdf.
///
/// > **Referencing an invoice in Sage 50 and ClearBooks**
/// >
/// > In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same. - ///
///
public class AccountingInvoice { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -77,9 +73,7 @@ public class AccountingInvoice public List? SalesOrderRefs { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -98,15 +92,12 @@ public class AccountingInvoice /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -125,15 +116,12 @@ public class AccountingInvoice /// >
/// > 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. - ///
///
[JsonProperty("dueDate")] public string? DueDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -152,34 +140,28 @@ public class AccountingInvoice /// >
/// > 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. - ///
///
[JsonProperty("paidOnDate")] public string? PaidOnDate { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -207,7 +189,6 @@ public class AccountingInvoice /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -277,15 +258,12 @@ public class AccountingInvoice /// /// Current state of the invoice:
- /// - /// ///
- /// - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
+ /// - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
/// - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld).
/// - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`.
/// - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`.
- /// - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. - ///
+ /// - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. ///
[JsonProperty("status")] public InvoiceStatus Status { get; set; } = default!; @@ -301,11 +279,8 @@ public class AccountingInvoice /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingInvoiceDataType.cs b/lending/Codat/Lending/Models/Components/AccountingInvoiceDataType.cs index 1fe74f9b5..fee62ceed 100644 --- a/lending/Codat/Lending/Models/Components/AccountingInvoiceDataType.cs +++ b/lending/Codat/Lending/Models/Components/AccountingInvoiceDataType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The underlying data type associated to the reference `id`. /// @@ -54,5 +54,4 @@ public static AccountingInvoiceDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingInvoiceDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingInvoices.cs b/lending/Codat/Lending/Models/Components/AccountingInvoices.cs index a427dd4d1..2020c9254 100644 --- a/lending/Codat/Lending/Models/Components/AccountingInvoices.cs +++ b/lending/Codat/Lending/Models/Components/AccountingInvoices.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingInvoices { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingJournal.cs b/lending/Codat/Lending/Models/Components/AccountingJournal.cs index 0faa4e3df..d0f186434 100644 --- a/lending/Codat/Lending/Models/Components/AccountingJournal.cs +++ b/lending/Codat/Lending/Models/Components/AccountingJournal.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the Journal entries data type
- /// - /// + /// > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the Journal entries data type
///
/// ## Overview
///
@@ -35,13 +33,10 @@ namespace Codat.Lending.Models.Components /// - Exact Online (mandatory)
/// - Oracle NetSuite (optional)
///
- /// > When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object.
- /// - ///
+ /// > When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. ///
public class AccountingJournal { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -62,10 +57,7 @@ public class AccountingJournal /// /// Journal name.
- /// - /// /// The maximum length for a journal name is 256 characters. All characters above that number will be truncated. - /// ///
[JsonProperty("name")] public string? Name { get; set; } = null; @@ -78,10 +70,7 @@ public class AccountingJournal /// /// Parent journal ID.
- /// - /// /// If the journal is a parent journal, this value is not present. - /// ///
[JsonProperty("parentId")] public string? ParentId { get; set; } = null; @@ -93,9 +82,7 @@ public class AccountingJournal public bool? HasChildren { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -114,7 +101,6 @@ public class AccountingJournal /// >
/// > 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. - ///
///
[JsonProperty("createdOn")] public string? CreatedOn { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingJournalEntries.cs b/lending/Codat/Lending/Models/Components/AccountingJournalEntries.cs index 4eb1185c3..2d0f21e14 100644 --- a/lending/Codat/Lending/Models/Components/AccountingJournalEntries.cs +++ b/lending/Codat/Lending/Models/Components/AccountingJournalEntries.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingJournalEntries { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingJournalEntry.cs b/lending/Codat/Lending/Models/Components/AccountingJournalEntry.cs index 9c7b5b613..4386fbc49 100644 --- a/lending/Codat/Lending/Models/Components/AccountingJournalEntry.cs +++ b/lending/Codat/Lending/Models/Components/AccountingJournalEntry.cs @@ -13,15 +13,13 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// > **Language tip:** For the top-level record of a company's financial transactions, refer to the Journals data type
- /// - /// + /// > **Language tip:** For the top-level record of a company's financial transactions, refer to the Journals data type
///
/// ## Overview
///
- /// A journal entry report shows the entries made in a company's general ledger, or accounts, when transactions are approved. The journal line items for each journal entry should balance.
+ /// A journal entry report shows the entries made in a company's general ledger, or accounts, when transactions are approved. The journal line items for each journal entry should balance.
///
/// A journal entry line item is a single transaction line on the journal entry. For example:
///
@@ -37,11 +35,9 @@ namespace Codat.Lending.Models.Components ///
/// > **Pushing journal entries**
/// > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. - ///
///
public class AccountingJournalEntry { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -61,9 +57,7 @@ public class AccountingJournalEntry public string? Description { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -82,15 +76,12 @@ public class AccountingJournalEntry /// >
/// > 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. - ///
///
[JsonProperty("postedOn")] public string? PostedOn { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -109,15 +100,12 @@ public class AccountingJournalEntry /// >
/// > 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. - ///
///
[JsonProperty("createdOn")] public string? CreatedOn { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -136,7 +124,6 @@ public class AccountingJournalEntry /// >
/// > 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. - ///
///
[JsonProperty("updatedOn")] public string? UpdatedOn { get; set; } @@ -164,11 +151,8 @@ public class AccountingJournalEntry /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingJournals.cs b/lending/Codat/Lending/Models/Components/AccountingJournals.cs index 802630cb1..58697f0ed 100644 --- a/lending/Codat/Lending/Models/Components/AccountingJournals.cs +++ b/lending/Codat/Lending/Models/Components/AccountingJournals.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingJournals { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingPayment.cs b/lending/Codat/Lending/Models/Components/AccountingPayment.cs index 8f2ba1e58..4f83f8386 100644 --- a/lending/Codat/Lending/Models/Components/AccountingPayment.cs +++ b/lending/Codat/Lending/Models/Components/AccountingPayment.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Payments or bill payments?**
- /// - /// /// >
/// > In Codat, payments represent accounts receivable only. For accounts payable, see bill payments. These include bills and credit notes against bills.
///
@@ -28,7 +26,7 @@ namespace Codat.Lending.Models.Components /// A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:
///
/// - A payment made against an invoice, like a credit card, cheque, or cash payment.
- /// - An allocation of a customer's credit note, either to an invoice or maybe a refund.
+ /// - An allocation of a customer's credit note, either to an invoice or maybe a refund.
/// - A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.
///
/// Depending on the payments allowed by the underlying accounting software, some payment types may be combined. Please see the example for more details.
@@ -129,7 +127,7 @@ namespace Codat.Lending.Models.Components ///
/// The **line** linked to the payment has the following properties:
///
- /// - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
+ /// - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
/// - A **links** array containing one element with the following properties:
/// - A **type** that indicates the type of **link**, in this case a `Refund`.
/// - An **id** that contains the ID of the payment that refunded this line.
@@ -152,26 +150,26 @@ namespace Codat.Lending.Models.Components /// - Base currency of the item the link represents.
/// - Foreign currency of the payment.
///
- /// These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:
+ /// These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:
///
/// - The base currency for the accounts receivable account.
/// - The currency of the item.
///
- /// ```json title="Currency rate example"
+ /// ```json title="Currency rate example"
/// {
- /// "id": "123",
- /// "note": "",
- /// "totalAmount": 99.99,
- /// "currency": "GBP",
- /// "lines": [
+ /// "id": "123",
+ /// "note": "",
+ /// "totalAmount": 99.99,
+ /// "currency": "GBP",
+ /// "lines": [
/// {
- /// "amount": 99.99,
- /// "links": [
+ /// "amount": 99.99,
+ /// "links": [
/// {
- /// "type": "Invoice",
- /// "id": "178",
- /// "amount": -50,
- /// "currencyRate": 1.9998
+ /// "type": "Invoice",
+ /// "id": "178",
+ /// "amount": -50,
+ /// "currencyRate": 1.9998
/// }
/// ]
/// }
@@ -189,17 +187,17 @@ namespace Codat.Lending.Models.Components ///
/// ## Simple examples
///
- /// ```json title="Payment for invoice"
+ /// ```json title="Payment for invoice"
/// {
- /// "totalAmount": 1000,
- /// "lines": [
+ /// "totalAmount": 1000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -209,22 +207,22 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Allocation of credit note"
+ /// ```json title="Allocation of credit note"
/// {
- /// "totalAmount": 0,
- /// "lines": [
+ /// "totalAmount": 0,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -234,27 +232,27 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Payment of invoice and payment on account"
+ /// ```json title="Payment of invoice and payment on account"
/// {
- /// "totalAmount": 2000,
- /// "lines": [
+ /// "totalAmount": 2000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "y",
- /// "amount" : -1000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "y",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -264,17 +262,17 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Refund of credit note"
+ /// ```json title="Refund of credit note"
/// {
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -284,17 +282,17 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Refund on accounts receivable account"
+ /// ```json title="Refund on accounts receivable account"
/// {
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -304,34 +302,34 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Linked refund on accounts receivable account"
+ /// ```json title="Linked refund on accounts receivable account"
/// {
- /// "id" : "payment-001",
- /// "totalAmount": 1000,
- /// "lines": [
+ /// "id" : "payment-001",
+ /// "totalAmount": 1000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Refund",
- /// "id" : "refund-001",
- /// "amount" : -1000
+ /// "type" : "Refund",
+ /// "id" : "refund-001",
+ /// "amount" : -1000
/// }
/// ]
/// }
/// ]
/// }
/// {
- /// "id" : "refund-001",
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "id" : "refund-001",
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "Payment",
- /// "id" : "payment-001",
- /// "amount" : 1000
+ /// "type" : "Payment",
+ /// "id" : "payment-001",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -341,32 +339,32 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Using a credit note and cash to pay an invoice"
+ /// ```json title="Using a credit note and cash to pay an invoice"
/// {
- /// "totalAmount": 250,
- /// "lines": [
+ /// "totalAmount": 250,
+ /// "lines": [
/// {
- /// "amount": 0,
- /// "links": [
+ /// "amount": 0,
+ /// "links": [
/// {
- /// "type": "Invoice",
- /// "id": "x",
- /// "amount": -750
+ /// "type": "Invoice",
+ /// "id": "x",
+ /// "amount": -750
/// },
/// {
- /// "type": "CreditNote",
- /// "id": "y",
- /// "amount": 750
+ /// "type": "CreditNote",
+ /// "id": "y",
+ /// "amount": 750
/// }
/// ]
/// },
/// {
- /// "amount": 250,
- /// "links": [
+ /// "amount": 250,
+ /// "links": [
/// {
- /// "type": "Invoice",
- /// "id": "x",
- /// "amount": -250
+ /// "type": "Invoice",
+ /// "id": "x",
+ /// "amount": -250
/// }
/// ]
/// }
@@ -378,47 +376,47 @@ namespace Codat.Lending.Models.Components ///
/// ## Complex examples
///
- /// ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
+ /// ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
/// {
- /// "totalAmount": 1000,
- /// "lines": [
+ /// "totalAmount": 1000,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -428,57 +426,57 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
+ /// ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
/// {
- /// "totalAmount": 2000,
- /// "lines": [
+ /// "totalAmount": 2000,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "customer-001",
- /// "amount" : -1000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "customer-001",
+ /// "amount" : -1000
/// }
/// ]
/// }
@@ -488,32 +486,32 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Two credit notes pay two invoices with no allocation amount specified"
+ /// ```json title="Two credit notes pay two invoices with no allocation amount specified"
/// {
- /// "totalAmount": 0,
- /// "lines": [
+ /// "totalAmount": 0,
+ /// "lines": [
/// {
- /// "amount" : 0,
- /// "links" : [
+ /// "amount" : 0,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "w",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "w",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -523,63 +521,63 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
+ /// ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
/// {
- /// "totalAmount": 2000,
- /// "lines": [
+ /// "totalAmount": 2000,
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "w",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "w",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "Invoice",
- /// "id" : "x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "x",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "Invoice",
- /// "id" : "u",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "u",
+ /// "amount" : -1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "y",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "y",
+ /// "amount" : 1000
/// },
/// {
- /// "type" : "CreditNote",
- /// "id" : "z",
- /// "amount" : 1000
+ /// "type" : "CreditNote",
+ /// "id" : "z",
+ /// "amount" : 1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Refund",
- /// "id" : "refund-001",
- /// "amount" : -1000
+ /// "type" : "Refund",
+ /// "id" : "refund-001",
+ /// "amount" : -1000
/// }
/// ]
/// }
/// ]
/// }
/// {
- /// "id" : "refund-001",
- /// "totalAmount": -1000,
- /// "lines": [
+ /// "id" : "refund-001",
+ /// "totalAmount": -1000,
+ /// "lines": [
/// {
- /// "amount" : -1000,
- /// "links" : [
+ /// "amount" : -1000,
+ /// "links" : [
/// {
- /// "type" : "Payment",
- /// "id" : "payment-001",
- /// "amount" : 1000
+ /// "type" : "Payment",
+ /// "id" : "payment-001",
+ /// "amount" : 1000
/// }
/// ]
/// }
@@ -591,29 +589,29 @@ namespace Codat.Lending.Models.Components ///
/// In this example, a payment on account is used to pay the same invoice in January and again in February.
///
- /// ```json title="January"
+ /// ```json title="January"
/// {
- /// "id": "001",
- /// "totalAmount": 5000,
- /// "date" : "1901-01-01",
- /// "lines": [
+ /// "id": "001",
+ /// "totalAmount": 5000,
+ /// "date" : "1901-01-01",
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "Invoice-x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "Invoice-x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 4000,
- /// "links" : [
+ /// "amount" : 4000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "PaymentOnAccount-y",
- /// "amount" : -4000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "PaymentOnAccount-y",
+ /// "amount" : -4000
/// }
/// ]
/// }
@@ -623,39 +621,39 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="February"
+ /// ```json title="February"
/// {
- /// "id": "001",
- /// "totalAmount": 5000,
- /// "date" : "1901-02-01",
- /// "lines": [
+ /// "id": "001",
+ /// "totalAmount": 5000,
+ /// "date" : "1901-02-01",
+ /// "lines": [
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "Invoice-x",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "Invoice-x",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 1000,
- /// "links" : [
+ /// "amount" : 1000,
+ /// "links" : [
/// {
- /// "type" : "Invoice",
- /// "id" : "Invoice-y",
- /// "amount" : -1000
+ /// "type" : "Invoice",
+ /// "id" : "Invoice-y",
+ /// "amount" : -1000
/// }
/// ]
/// },
/// {
- /// "amount" : 3000,
- /// "links" : [
+ /// "amount" : 3000,
+ /// "links" : [
/// {
- /// "type" : "PaymentOnAccount",
- /// "id" : "PaymentOnAccount-y",
- /// "amount" : -3000
+ /// "type" : "PaymentOnAccount",
+ /// "id" : "PaymentOnAccount-y",
+ /// "amount" : -3000
/// }
/// ]
/// }
@@ -665,39 +663,37 @@ namespace Codat.Lending.Models.Components ///
///
///
- /// ```json title="Two credit notes and some cash pay two invoices with no allocations specified"
+ /// ```json title="Two credit notes and some cash pay two invoices with no allocations specified"
/// {
- /// "totalAmount": 500,
- /// "lines": [
+ /// "totalAmount": 500,
+ /// "lines": [
/// {
- /// "amount": 500,
- /// "links": [{
- /// "type": "Invoice",
- /// "id": "a",
- /// "amount": -1000
+ /// "amount": 500,
+ /// "links": [{
+ /// "type": "Invoice",
+ /// "id": "a",
+ /// "amount": -1000
/// }, {
- /// "type": "Invoice",
- /// "id": "b",
- /// "amount": -1000
+ /// "type": "Invoice",
+ /// "id": "b",
+ /// "amount": -1000
/// }, {
- /// "type": "CreditNote",
- /// "id": "y",
- /// "amount": 750
+ /// "type": "CreditNote",
+ /// "id": "y",
+ /// "amount": 750
/// },{
- /// "type": "CreditNote",
- /// "id": "z",
- /// "amount": 750
+ /// "type": "CreditNote",
+ /// "id": "z",
+ /// "amount": 750
/// }
/// ]
/// }
/// ]
/// }
/// ``` - ///
///
public class AccountingPayment { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -726,34 +722,29 @@ public class AccountingPayment public PaymentMethodRef? PaymentMethodRef { get; set; } /// - /// Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. + /// Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. /// [JsonProperty("totalAmount")] public decimal? TotalAmount { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -781,15 +772,12 @@ public class AccountingPayment /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -808,7 +796,6 @@ public class AccountingPayment /// >
/// > 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. - ///
///
[JsonProperty("date")] public string Date { get; set; } = default!; @@ -836,11 +823,8 @@ public class AccountingPayment /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingPaymentAllocation.cs b/lending/Codat/Lending/Models/Components/AccountingPaymentAllocation.cs index 66b2cd833..536a6a97c 100644 --- a/lending/Codat/Lending/Models/Components/AccountingPaymentAllocation.cs +++ b/lending/Codat/Lending/Models/Components/AccountingPaymentAllocation.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AccountingPaymentAllocation { - [JsonProperty("payment")] public PaymentAllocationPayment Payment { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/AccountingPayments.cs b/lending/Codat/Lending/Models/Components/AccountingPayments.cs index 737c08257..47a000878 100644 --- a/lending/Codat/Lending/Models/Components/AccountingPayments.cs +++ b/lending/Codat/Lending/Models/Components/AccountingPayments.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingPayments { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingProfitAndLossReport.cs b/lending/Codat/Lending/Models/Components/AccountingProfitAndLossReport.cs index fc4592845..66b1294a1 100644 --- a/lending/Codat/Lending/Models/Components/AccountingProfitAndLossReport.cs +++ b/lending/Codat/Lending/Models/Components/AccountingProfitAndLossReport.cs @@ -13,17 +13,15 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).
- /// - /// ///
/// ## Overview
///
/// The purpose of a profit and loss report is to present the financial performance of a company over a specified time period.
///
- /// A profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made.
+ /// A profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made.
///
/// > **Profit and loss or balance sheet?**
/// > Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date.
@@ -37,11 +35,9 @@ namespace Codat.Lending.Models.Components ///
/// **Want to pull this in a standardised structure?**
/// Our Enhanced Financials endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. - ///
///
public class AccountingProfitAndLossReport { - /// /// An array of profit and loss reports. /// @@ -61,9 +57,7 @@ public class AccountingProfitAndLossReport public string? Currency { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -82,15 +76,12 @@ public class AccountingProfitAndLossReport /// >
/// > 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. - ///
///
[JsonProperty("mostRecentAvailableMonth")] public string? MostRecentAvailableMonth { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -109,7 +100,6 @@ public class AccountingProfitAndLossReport /// >
/// > 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. - ///
///
[JsonProperty("earliestAvailableMonth")] public string? EarliestAvailableMonth { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingRecordRef.cs b/lending/Codat/Lending/Models/Components/AccountingRecordRef.cs index e344873d8..831b5827f 100644 --- a/lending/Codat/Lending/Models/Components/AccountingRecordRef.cs +++ b/lending/Codat/Lending/Models/Components/AccountingRecordRef.cs @@ -11,26 +11,22 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links the current record to the underlying record or data type that created it.
- /// - /// ///
- /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - ///
+ /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. ///
public class AccountingRecordRef { - /// - /// 'id' of the underlying record or data type. + /// 'id' of the underlying record or data type. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// [JsonProperty("dataType")] public string? DataType { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingSupplier.cs b/lending/Codat/Lending/Models/Components/AccountingSupplier.cs index bd069f55b..11fad730e 100644 --- a/lending/Codat/Lending/Models/Components/AccountingSupplier.cs +++ b/lending/Codat/Lending/Models/Components/AccountingSupplier.cs @@ -13,18 +13,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## Overview
- /// - /// ///
- /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. - ///
+ /// From the **Suppliers** endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills. ///
public class AccountingSupplier { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -74,7 +70,7 @@ public class AccountingSupplier public string? RegistrationNumber { get; set; } = null; /// - /// Supplier's company tax number. + /// Supplier's company tax number. /// [JsonProperty("taxNumber")] public string? TaxNumber { get; set; } = null; @@ -86,7 +82,7 @@ public class AccountingSupplier public SupplierStatus Status { get; set; } = default!; /// - /// Default currency the supplier's transactional data is recorded in. + /// Default currency the supplier's transactional data is recorded in. /// [JsonProperty("defaultCurrency")] public string? DefaultCurrency { get; set; } = null; @@ -96,11 +92,8 @@ public class AccountingSupplier /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingSuppliers.cs b/lending/Codat/Lending/Models/Components/AccountingSuppliers.cs index cf2674c77..57149a4cb 100644 --- a/lending/Codat/Lending/Models/Components/AccountingSuppliers.cs +++ b/lending/Codat/Lending/Models/Components/AccountingSuppliers.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingSuppliers { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingTransfer.cs b/lending/Codat/Lending/Models/Components/AccountingTransfer.cs index 3e9a23e8e..f9dfc991b 100644 --- a/lending/Codat/Lending/Models/Components/AccountingTransfer.cs +++ b/lending/Codat/Lending/Models/Components/AccountingTransfer.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of account transactions. /// public class AccountingTransfer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -42,9 +41,7 @@ public class AccountingTransfer public ContactRef? ContactRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -63,7 +60,6 @@ public class AccountingTransfer /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } @@ -81,7 +77,7 @@ public class AccountingTransfer public TransferAccount? To { get; set; } /// - /// The status of the transfer in the account + /// The status of the transfer in the account. /// [JsonProperty("status")] public AccountingTransferStatus? Status { get; set; } = null; @@ -103,11 +99,8 @@ public class AccountingTransfer /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountingTransferStatus.cs b/lending/Codat/Lending/Models/Components/AccountingTransferStatus.cs index 97396a01a..c316c967d 100644 --- a/lending/Codat/Lending/Models/Components/AccountingTransferStatus.cs +++ b/lending/Codat/Lending/Models/Components/AccountingTransferStatus.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// The status of the transfer in the account + /// The status of the transfer in the account. /// public enum AccountingTransferStatus { @@ -60,5 +60,4 @@ public static AccountingTransferStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountingTransferStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/AccountingTransfers.cs b/lending/Codat/Lending/Models/Components/AccountingTransfers.cs index 554a11c70..9129fe47d 100644 --- a/lending/Codat/Lending/Models/Components/AccountingTransfers.cs +++ b/lending/Codat/Lending/Models/Components/AccountingTransfers.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AccountingTransfers { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Accounts.cs b/lending/Codat/Lending/Models/Components/Accounts.cs index 4e31009e9..f2280e947 100644 --- a/lending/Codat/Lending/Models/Components/Accounts.cs +++ b/lending/Codat/Lending/Models/Components/Accounts.cs @@ -12,18 +12,17 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class Accounts { - /// - /// A source reference containing the `sourceType` object "Banking". + /// A source reference containing the `sourceType` object "Banking". /// [JsonProperty("sourceRef")] public ReportSourceReference? SourceRef { get; set; } /// - /// Name of the banking data source, e.g. "Plaid". + /// Name of the banking data source, e.g. "Plaid". /// [JsonProperty("platformName")] public string? PlatformName { get; set; } @@ -48,15 +47,12 @@ public class Accounts /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AccountsPayableTracking.cs b/lending/Codat/Lending/Models/Components/AccountsPayableTracking.cs index 1c9002e92..b3489f858 100644 --- a/lending/Codat/Lending/Models/Components/AccountsPayableTracking.cs +++ b/lending/Codat/Lending/Models/Components/AccountsPayableTracking.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// Categories, and a project and customer, against which the item is tracked. /// public class AccountsPayableTracking { - [JsonProperty("categoryRefs")] public List CategoryRefs { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/AccountsReceivableTracking.cs b/lending/Codat/Lending/Models/Components/AccountsReceivableTracking.cs index 5c9432a68..0809f4f09 100644 --- a/lending/Codat/Lending/Models/Components/AccountsReceivableTracking.cs +++ b/lending/Codat/Lending/Models/Components/AccountsReceivableTracking.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// Categories, and a project and customer, against which the item is tracked. /// public class AccountsReceivableTracking { - [JsonProperty("categoryRefs")] public List CategoryRefs { get; set; } = default!; @@ -43,11 +42,8 @@ public class AccountsReceivableTracking /// /// Links the current record to the underlying record or data type that created it.
- /// - /// ///
- /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - ///
+ /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. ///
[JsonProperty("recordRef")] public AccountingRecordRef? RecordRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AgedCreditor.cs b/lending/Codat/Lending/Models/Components/AgedCreditor.cs index fdd098341..a64c336cd 100644 --- a/lending/Codat/Lending/Models/Components/AgedCreditor.cs +++ b/lending/Codat/Lending/Models/Components/AgedCreditor.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AgedCreditor { - /// /// Supplier ID of the aged creditor. /// diff --git a/lending/Codat/Lending/Models/Components/AgedCurrencyOutstanding.cs b/lending/Codat/Lending/Models/Components/AgedCurrencyOutstanding.cs index b2d9a6770..e3afb81d6 100644 --- a/lending/Codat/Lending/Models/Components/AgedCurrencyOutstanding.cs +++ b/lending/Codat/Lending/Models/Components/AgedCurrencyOutstanding.cs @@ -13,21 +13,17 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AgedCurrencyOutstanding { - /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AgedDebtor.cs b/lending/Codat/Lending/Models/Components/AgedDebtor.cs index ebcda3a7e..12aee9e55 100644 --- a/lending/Codat/Lending/Models/Components/AgedDebtor.cs +++ b/lending/Codat/Lending/Models/Components/AgedDebtor.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AgedDebtor { - /// /// Customer ID of the aged debtor. /// diff --git a/lending/Codat/Lending/Models/Components/AgedOutstandingAmount.cs b/lending/Codat/Lending/Models/Components/AgedOutstandingAmount.cs index 9409d29e0..a80c12bc9 100644 --- a/lending/Codat/Lending/Models/Components/AgedOutstandingAmount.cs +++ b/lending/Codat/Lending/Models/Components/AgedOutstandingAmount.cs @@ -13,14 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class AgedOutstandingAmount { - /// - /// 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:
- /// - /// + /// 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
@@ -39,15 +36,12 @@ public class AgedOutstandingAmount /// >
/// > 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. - ///
///
[JsonProperty("fromDate")] public string? FromDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -66,7 +60,6 @@ public class AgedOutstandingAmount /// >
/// > 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. - ///
///
[JsonProperty("toDate")] public string? ToDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/AgedOutstandingAmountDetail.cs b/lending/Codat/Lending/Models/Components/AgedOutstandingAmountDetail.cs index eb80a7271..b2f67108f 100644 --- a/lending/Codat/Lending/Models/Components/AgedOutstandingAmountDetail.cs +++ b/lending/Codat/Lending/Models/Components/AgedOutstandingAmountDetail.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class AgedOutstandingAmountDetail { - /// /// Name of data type with outstanding amount for given period. /// diff --git a/lending/Codat/Lending/Models/Components/Allocation.cs b/lending/Codat/Lending/Models/Components/Allocation.cs index 73365c036..5a121d993 100644 --- a/lending/Codat/Lending/Models/Components/Allocation.cs +++ b/lending/Codat/Lending/Models/Components/Allocation.cs @@ -11,33 +11,27 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class Allocation { - /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -65,15 +59,12 @@ public class Allocation /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -92,7 +83,6 @@ public class Allocation /// >
/// > 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. - ///
///
[JsonProperty("allocatedOnDate")] public string? AllocatedOnDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Attachments.cs b/lending/Codat/Lending/Models/Components/Attachments.cs index e32f4d9cd..6cd8b6326 100644 --- a/lending/Codat/Lending/Models/Components/Attachments.cs +++ b/lending/Codat/Lending/Models/Components/Attachments.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Attachments { - [JsonProperty("attachments")] public List? AttachmentsValue { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Components/BalanceSheet.cs b/lending/Codat/Lending/Models/Components/BalanceSheet.cs index 0bbd1ffe0..96fe74792 100644 --- a/lending/Codat/Lending/Models/Components/BalanceSheet.cs +++ b/lending/Codat/Lending/Models/Components/BalanceSheet.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class BalanceSheet { - /// - /// 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:
- /// - /// + /// 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
@@ -38,7 +35,6 @@ public class BalanceSheet /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankAccountRef.cs b/lending/Codat/Lending/Models/Components/BankAccountRef.cs index 9c4d5bc24..de36a8042 100644 --- a/lending/Codat/Lending/Models/Components/BankAccountRef.cs +++ b/lending/Codat/Lending/Models/Components/BankAccountRef.cs @@ -11,21 +11,20 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links to the Account transactions data type. /// public class BankAccountRef { - /// - /// Bank account 'id' for the account transaction. + /// Bank account 'id' for the account transaction. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// bank account 'name' for the account transaction. + /// bank account 'name' for the account transaction. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankAccountStatus.cs b/lending/Codat/Lending/Models/Components/BankAccountStatus.cs index 0e249728e..77235933c 100644 --- a/lending/Codat/Lending/Models/Components/BankAccountStatus.cs +++ b/lending/Codat/Lending/Models/Components/BankAccountStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the bank account. /// @@ -60,5 +60,4 @@ public static BankAccountStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BankAccountStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BankFeedBankAccountMapping.cs b/lending/Codat/Lending/Models/Components/BankFeedBankAccountMapping.cs index 28c140516..f1a0c7d91 100644 --- a/lending/Codat/Lending/Models/Components/BankFeedBankAccountMapping.cs +++ b/lending/Codat/Lending/Models/Components/BankFeedBankAccountMapping.cs @@ -11,26 +11,23 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class BankFeedBankAccountMapping { - /// - /// Unique ID for the source account + /// Unique ID for the source account. /// [JsonProperty("sourceAccountId")] public string SourceAccountId { get; set; } = default!; /// - /// Unique ID for the target account + /// Unique ID for the target account. /// [JsonProperty("targetAccountId")] public string? TargetAccountId { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -49,7 +46,6 @@ public class BankFeedBankAccountMapping /// >
/// > 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. - ///
///
[JsonProperty("feedStartDate")] public string? FeedStartDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankFeedBankAccountMappingResponse.cs b/lending/Codat/Lending/Models/Components/BankFeedBankAccountMappingResponse.cs index 3e83bb9bc..7beb5bfd5 100644 --- a/lending/Codat/Lending/Models/Components/BankFeedBankAccountMappingResponse.cs +++ b/lending/Codat/Lending/Models/Components/BankFeedBankAccountMappingResponse.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class BankFeedBankAccountMappingResponse { - /// /// Unique ID for the source account. /// @@ -34,7 +33,7 @@ public class BankFeedBankAccountMappingResponse public string? Status { get; set; } = null; /// - /// Error returned during the post request + /// Error returned during the post request. /// [JsonProperty("error")] public string? Error { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/BankFeedMapping.cs b/lending/Codat/Lending/Models/Components/BankFeedMapping.cs index b98042a83..173a020d8 100644 --- a/lending/Codat/Lending/Models/Components/BankFeedMapping.cs +++ b/lending/Codat/Lending/Models/Components/BankFeedMapping.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// A bank feed connection between a source account and a target account, including potential target accounts. /// public class BankFeedMapping { - /// /// Unique ID for the source account. /// @@ -46,15 +45,12 @@ public class BankFeedMapping /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("sourceCurrency")] public string? SourceCurrency { get; set; } @@ -84,9 +80,7 @@ public class BankFeedMapping public List? TargetAccountOptions { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -105,7 +99,6 @@ public class BankFeedMapping /// >
/// > 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. - ///
///
[JsonProperty("feedStartDate")] public string? FeedStartDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankStatementUploadConfiguration.cs b/lending/Codat/Lending/Models/Components/BankStatementUploadConfiguration.cs index 629d3dcf6..b1d5765b6 100644 --- a/lending/Codat/Lending/Models/Components/BankStatementUploadConfiguration.cs +++ b/lending/Codat/Lending/Models/Components/BankStatementUploadConfiguration.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// Configuration settings for uploading banking data to Codat + /// Configuration settings for uploading banking data to Codat. /// public class BankStatementUploadConfiguration { - /// - /// The source of the banking data that determines its format + /// The source of the banking data that determines its format. /// [JsonProperty("source")] public Source? Source { get; set; } /// - /// The ID of the account in the third-party platform + /// The ID of the account in the third-party platform. /// [JsonProperty("accountId")] public string? AccountId { get; set; } /// - /// TrueLayer provider ID (only required if source is TrueLayer) + /// TrueLayer provider ID (only required if source is TrueLayer). /// [JsonProperty("providerId")] public string? ProviderId { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankTransactionType.cs b/lending/Codat/Lending/Models/Components/BankTransactionType.cs index 41b70c9d5..1c1cb2549 100644 --- a/lending/Codat/Lending/Models/Components/BankTransactionType.cs +++ b/lending/Codat/Lending/Models/Components/BankTransactionType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Type of transaction for the bank statement line. /// @@ -88,5 +88,4 @@ public static BankTransactionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BankTransactionType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BankingAccount.cs b/lending/Codat/Lending/Models/Components/BankingAccount.cs index 7a17a5a58..66e69f7f7 100644 --- a/lending/Codat/Lending/Models/Components/BankingAccount.cs +++ b/lending/Codat/Lending/Models/Components/BankingAccount.cs @@ -12,18 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts.
- /// - /// + /// This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts.
///
/// Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. - ///
///
public class BankingAccount { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -56,11 +52,8 @@ public class BankingAccount /// /// 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. - ///
///
[JsonProperty("type")] public AccountingBankAccountType Type { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/BankingAccountBalance.cs b/lending/Codat/Lending/Models/Components/BankingAccountBalance.cs index 64c3c85f2..5fd616110 100644 --- a/lending/Codat/Lending/Models/Components/BankingAccountBalance.cs +++ b/lending/Codat/Lending/Models/Components/BankingAccountBalance.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction.
- /// - /// ///
/// Responses are paged, so you should provide `page` and `pageSize` query parameters in your request.
///
@@ -25,11 +23,9 @@ namespace Codat.Lending.Models.Components /// > Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the Account data type.
/// >
/// > Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer. - ///
///
public class BankingAccountBalance { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -49,9 +45,7 @@ public class BankingAccountBalance public AccountBalanceAmounts Balance { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -70,7 +64,6 @@ public class BankingAccountBalance /// >
/// > 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. - ///
///
[JsonProperty("date")] public string Date { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/BankingAccountBalances.cs b/lending/Codat/Lending/Models/Components/BankingAccountBalances.cs index 4b833099b..16a6e52c1 100644 --- a/lending/Codat/Lending/Models/Components/BankingAccountBalances.cs +++ b/lending/Codat/Lending/Models/Components/BankingAccountBalances.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class BankingAccountBalances { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankingAccounts.cs b/lending/Codat/Lending/Models/Components/BankingAccounts.cs index fd546bbbc..ae9556333 100644 --- a/lending/Codat/Lending/Models/Components/BankingAccounts.cs +++ b/lending/Codat/Lending/Models/Components/BankingAccounts.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class BankingAccounts { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankingTransaction.cs b/lending/Codat/Lending/Models/Components/BankingTransaction.cs index 2c0f99a04..b739f2fa4 100644 --- a/lending/Codat/Lending/Models/Components/BankingTransaction.cs +++ b/lending/Codat/Lending/Models/Components/BankingTransaction.cs @@ -12,18 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure.
- /// - /// ///
/// Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. - ///
///
public class BankingTransaction { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -61,9 +57,7 @@ public class BankingTransaction public string Currency { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -82,15 +76,12 @@ public class BankingTransaction /// >
/// > 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. - ///
///
[JsonProperty("postedDate")] public string? PostedDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -109,7 +100,6 @@ public class BankingTransaction /// >
/// > 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. - ///
///
[JsonProperty("authorizedDate")] public string? AuthorizedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankingTransactionCategories.cs b/lending/Codat/Lending/Models/Components/BankingTransactionCategories.cs index c2f8bb4f5..2a5b78aec 100644 --- a/lending/Codat/Lending/Models/Components/BankingTransactionCategories.cs +++ b/lending/Codat/Lending/Models/Components/BankingTransactionCategories.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class BankingTransactionCategories { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankingTransactionCategory.cs b/lending/Codat/Lending/Models/Components/BankingTransactionCategory.cs index 86be5a396..fe6faea41 100644 --- a/lending/Codat/Lending/Models/Components/BankingTransactionCategory.cs +++ b/lending/Codat/Lending/Models/Components/BankingTransactionCategory.cs @@ -12,18 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity.
- /// - /// ///
/// Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. - ///
///
public class BankingTransactionCategory { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankingTransactionRef.cs b/lending/Codat/Lending/Models/Components/BankingTransactionRef.cs index c939ae544..58c614095 100644 --- a/lending/Codat/Lending/Models/Components/BankingTransactionRef.cs +++ b/lending/Codat/Lending/Models/Components/BankingTransactionRef.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class BankingTransactionRef { - /// /// Unique identifier for the bank transaction. /// @@ -22,13 +21,13 @@ public class BankingTransactionRef public string? Id { get; set; } /// - /// Unique identifier of the bank transaction's connection. + /// Unique identifier of the bank transaction's connection. /// [JsonProperty("dataConnectionId")] public string? DataConnectionId { get; set; } /// - /// Unique identifier of the bank transaction's account. + /// Unique identifier of the bank transaction's account. /// [JsonProperty("accountId")] public string? AccountId { get; set; } @@ -40,9 +39,7 @@ public class BankingTransactionRef public string? AccountName { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -61,7 +58,6 @@ public class BankingTransactionRef /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BankingTransactions.cs b/lending/Codat/Lending/Models/Components/BankingTransactions.cs index 88fa2bb70..6e132ec7d 100644 --- a/lending/Codat/Lending/Models/Components/BankingTransactions.cs +++ b/lending/Codat/Lending/Models/Components/BankingTransactions.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class BankingTransactions { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BillCreditNoteLineItem.cs b/lending/Codat/Lending/Models/Components/BillCreditNoteLineItem.cs index f5fe8114b..d7357c8ce 100644 --- a/lending/Codat/Lending/Models/Components/BillCreditNoteLineItem.cs +++ b/lending/Codat/Lending/Models/Components/BillCreditNoteLineItem.cs @@ -14,10 +14,9 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class BillCreditNoteLineItem { - /// /// Friendly name of each line item. For example, the goods or service for which credit has been received. /// @@ -37,7 +36,7 @@ public class BillCreditNoteLineItem public decimal Quantity { get; set; } = default!; /// - /// The measurement which defines a unit for this item (e.g. 'kilogram', 'litre'). + /// The measurement which defines a unit for this item (e.g. 'kilogram', 'litre'). /// [JsonProperty("unitOfMeasurement")] public string? UnitOfMeasurement { get; set; } = null; @@ -80,8 +79,6 @@ public class BillCreditNoteLineItem /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -90,8 +87,7 @@ public class BillCreditNoteLineItem /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
[JsonProperty("taxRateRef")] public TaxRateReference? TaxRateRef { get; set; } @@ -104,11 +100,8 @@ public class BillCreditNoteLineItem /// /// Links the current record line to the underlying record line that created it.
- /// - /// ///
- /// For example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. - ///
+ /// For example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. ///
[JsonProperty("createdFromLineRef")] public Zero? CreatedFromLineRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BillCreditNoteStatus.cs b/lending/Codat/Lending/Models/Components/BillCreditNoteStatus.cs index 9113d0faa..7a244f0e0 100644 --- a/lending/Codat/Lending/Models/Components/BillCreditNoteStatus.cs +++ b/lending/Codat/Lending/Models/Components/BillCreditNoteStatus.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Current state of the bill credit note + /// Current state of the bill credit note. /// public enum BillCreditNoteStatus { @@ -64,5 +64,4 @@ public static BillCreditNoteStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BillCreditNoteStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BillLineItem.cs b/lending/Codat/Lending/Models/Components/BillLineItem.cs index a651df882..6b4fe7e03 100644 --- a/lending/Codat/Lending/Models/Components/BillLineItem.cs +++ b/lending/Codat/Lending/Models/Components/BillLineItem.cs @@ -13,12 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class BillLineItem { - /// - /// The bill line's number. + /// The bill line's number. /// [JsonProperty("lineNumber")] public string? LineNumber { get; set; } = null; @@ -42,18 +41,15 @@ public class BillLineItem public decimal? Quantity { get; set; } /// - /// The measurement which defines a unit for this item (e.g. 'kilogram', 'litre'). + /// The measurement which defines a unit for this item (e.g. 'kilogram', 'litre'). /// [JsonProperty("unitOfMeasurement")] public string? UnitOfMeasurement { get; set; } = null; /// /// Numerical value of any discounts applied.
- /// - /// ///
/// Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. - ///
///
[JsonProperty("discountAmount")] public decimal? DiscountAmount { get; set; } = null; @@ -90,8 +86,6 @@ public class BillLineItem /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -100,8 +94,7 @@ public class BillLineItem /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
[JsonProperty("taxRateRef")] public TaxRateRef? TaxRateRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BillLineItemDataType.cs b/lending/Codat/Lending/Models/Components/BillLineItemDataType.cs index 94d25f81c..98d9871bf 100644 --- a/lending/Codat/Lending/Models/Components/BillLineItemDataType.cs +++ b/lending/Codat/Lending/Models/Components/BillLineItemDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// public enum BillLineItemDataType { @@ -56,5 +56,4 @@ public static BillLineItemDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BillLineItemDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BillPaymentLine.cs b/lending/Codat/Lending/Models/Components/BillPaymentLine.cs index 689c5f944..57b5d35ab 100644 --- a/lending/Codat/Lending/Models/Components/BillPaymentLine.cs +++ b/lending/Codat/Lending/Models/Components/BillPaymentLine.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class BillPaymentLine { - /// /// Amount in the bill payment currency. /// @@ -27,9 +26,7 @@ public class BillPaymentLine public List? Links { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -48,7 +45,6 @@ public class BillPaymentLine /// >
/// > 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. - ///
///
[JsonProperty("allocatedOnDate")] public string? AllocatedOnDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/BillPaymentLineLink.cs b/lending/Codat/Lending/Models/Components/BillPaymentLineLink.cs index 1d7d882ed..9ad1c7665 100644 --- a/lending/Codat/Lending/Models/Components/BillPaymentLineLink.cs +++ b/lending/Codat/Lending/Models/Components/BillPaymentLineLink.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class BillPaymentLineLink { - /// /// Types of links to bill payment lines. /// @@ -30,24 +29,19 @@ public class BillPaymentLineLink /// /// Amount by which the balance of the linked entity is altered, in the currency of the linked entity.
- /// - /// ///
/// - A negative link amount reduces the outstanding amount on the accounts payable account.
/// - A positive link amount increases the outstanding amount on the accounts payable account. - ///
///
[JsonProperty("amount")] public decimal? Amount { get; set; } = null; /// /// 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.
+ /// 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).
///
@@ -75,7 +69,6 @@ public class BillPaymentLineLink /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/BillPaymentLineLinkType.cs b/lending/Codat/Lending/Models/Components/BillPaymentLineLinkType.cs index 33e44d7a4..bfc4d3d29 100644 --- a/lending/Codat/Lending/Models/Components/BillPaymentLineLinkType.cs +++ b/lending/Codat/Lending/Models/Components/BillPaymentLineLinkType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Types of links to bill payment lines. /// @@ -72,5 +72,4 @@ public static BillPaymentLineLinkType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BillPaymentLineLinkType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BillStatus.cs b/lending/Codat/Lending/Models/Components/BillStatus.cs index f9313ec90..dc2bb8fc2 100644 --- a/lending/Codat/Lending/Models/Components/BillStatus.cs +++ b/lending/Codat/Lending/Models/Components/BillStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Current state of the bill. /// @@ -64,5 +64,4 @@ public static BillStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BillStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BilledToType.cs b/lending/Codat/Lending/Models/Components/BilledToType.cs index b5ae787ca..57bffa1fa 100644 --- a/lending/Codat/Lending/Models/Components/BilledToType.cs +++ b/lending/Codat/Lending/Models/Components/BilledToType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Defines if the invoice or credit note is billed/rebilled to a project or customer. /// @@ -60,5 +60,4 @@ public static BilledToType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BilledToType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/BilledToType1.cs b/lending/Codat/Lending/Models/Components/BilledToType1.cs index 03a69211c..4104b1508 100644 --- a/lending/Codat/Lending/Models/Components/BilledToType1.cs +++ b/lending/Codat/Lending/Models/Components/BilledToType1.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Defines if the bill or bill credit note is billed/rebilled to a project. /// @@ -58,5 +58,4 @@ public static BilledToType1 ToEnum(this string value) throw new Exception($"Unknown value {value} for enum BilledToType1"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/CashFlowStatement.cs b/lending/Codat/Lending/Models/Components/CashFlowStatement.cs index f489426c1..48b738c6f 100644 --- a/lending/Codat/Lending/Models/Components/CashFlowStatement.cs +++ b/lending/Codat/Lending/Models/Components/CashFlowStatement.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CashFlowStatement { - /// - /// 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:
- /// - /// + /// 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
@@ -38,15 +35,12 @@ public class CashFlowStatement /// >
/// > 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. - ///
///
[JsonProperty("fromDate")] public string? FromDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -65,7 +59,6 @@ public class CashFlowStatement /// >
/// > 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. - ///
///
[JsonProperty("toDate")] public string? ToDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CashFlowTransaction.cs b/lending/Codat/Lending/Models/Components/CashFlowTransaction.cs index 4a44e08b2..85def732c 100644 --- a/lending/Codat/Lending/Models/Components/CashFlowTransaction.cs +++ b/lending/Codat/Lending/Models/Components/CashFlowTransaction.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CashFlowTransaction { - /// /// The unique identifier of the bank transaction. /// @@ -24,9 +23,7 @@ public class CashFlowTransaction public string? Id { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -45,7 +42,6 @@ public class CashFlowTransaction /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } @@ -64,15 +60,12 @@ public class CashFlowTransaction /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -93,7 +86,7 @@ public class CashFlowTransaction public List? CounterpartyNames { get; set; } /// - /// A source reference containing the `sourceType` object "Banking". + /// A source reference containing the `sourceType` object "Banking". /// [JsonProperty("sourceRef")] public SourceRef? SourceRef { get; set; } @@ -105,9 +98,7 @@ public class CashFlowTransaction public AccountRef? AccountRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -126,9 +117,14 @@ public class CashFlowTransaction /// >
/// > 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. - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } + + /// + /// Indicates if the transaction is classified as recurring by Codat's categorization engine. + /// + [JsonProperty("isRecurring")] + public bool? IsRecurring { get; set; } = null; } } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ClientRateLimitWebhook.cs b/lending/Codat/Lending/Models/Components/ClientRateLimitWebhook.cs index 41ebc75a7..22bf11174 100644 --- a/lending/Codat/Lending/Models/Components/ClientRateLimitWebhook.cs +++ b/lending/Codat/Lending/Models/Components/ClientRateLimitWebhook.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ClientRateLimitWebhook { - /// /// Unique identifier of the event. /// @@ -29,9 +28,7 @@ public class ClientRateLimitWebhook public string? EventType { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -50,7 +47,6 @@ public class ClientRateLimitWebhook /// >
/// > 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. - ///
///
[JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ClientRateLimitWebhookPayload.cs b/lending/Codat/Lending/Models/Components/ClientRateLimitWebhookPayload.cs index 1a74e4cee..db2a6bea3 100644 --- a/lending/Codat/Lending/Models/Components/ClientRateLimitWebhookPayload.cs +++ b/lending/Codat/Lending/Models/Components/ClientRateLimitWebhookPayload.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ClientRateLimitWebhookPayload { - /// /// The number of available requests per day. /// @@ -28,9 +27,7 @@ public class ClientRateLimitWebhookPayload public long? QuotaRemaining { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -49,7 +46,6 @@ public class ClientRateLimitWebhookPayload /// >
/// > 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. - ///
///
[JsonProperty("expiryDate")] public string? ExpiryDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CodatFile.cs b/lending/Codat/Lending/Models/Components/CodatFile.cs index 240c9f460..8dd3facce 100644 --- a/lending/Codat/Lending/Models/Components/CodatFile.cs +++ b/lending/Codat/Lending/Models/Components/CodatFile.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; - + public class CodatFile { - [SpeakeasyMetadata("multipartForm:name=fileName")] public string FileName { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/CommerceAddress.cs b/lending/Codat/Lending/Models/Components/CommerceAddress.cs index a14029208..2015802c5 100644 --- a/lending/Codat/Lending/Models/Components/CommerceAddress.cs +++ b/lending/Codat/Lending/Models/Components/CommerceAddress.cs @@ -12,48 +12,47 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CommerceAddress { - /// - /// The type of the address + /// The type of the address. /// [JsonProperty("type")] public CommerceAddressType? Type { get; set; } /// - /// The first line of the address + /// The first line of the address. /// [JsonProperty("line1")] public string? Line1 { get; set; } /// - /// The second line of the address + /// The second line of the address. /// [JsonProperty("line2")] public string? Line2 { get; set; } /// - /// The third line of the address, or city + /// The third line of the address, or city. /// [JsonProperty("city")] public string? City { get; set; } /// - /// The fourth line of the address, or region + /// The fourth line of the address, or region. /// [JsonProperty("region")] public string? Region { get; set; } /// - /// The country for the address + /// The country for the address. /// [JsonProperty("country")] public string? Country { get; set; } /// - /// The postal (or zip) code for the address + /// The postal (or zip) code for the address. /// [JsonProperty("postalCode")] public string? PostalCode { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceAddressType.cs b/lending/Codat/Lending/Models/Components/CommerceAddressType.cs index fba65c8e6..7ba14422e 100644 --- a/lending/Codat/Lending/Models/Components/CommerceAddressType.cs +++ b/lending/Codat/Lending/Models/Components/CommerceAddressType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of the address + /// The type of the address. /// public enum CommerceAddressType { @@ -62,5 +62,4 @@ public static CommerceAddressType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CommerceAddressType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/CommerceCompanyInfo.cs b/lending/Codat/Lending/Models/Components/CommerceCompanyInfo.cs index 5e076d81e..dab4fc372 100644 --- a/lending/Codat/Lending/Models/Components/CommerceCompanyInfo.cs +++ b/lending/Codat/Lending/Models/Components/CommerceCompanyInfo.cs @@ -13,18 +13,13 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// In the Codat system, company profile includes standard commercial details about
- /// - /// - /// a linked company, such as their address, phone number, and company registration.
- /// - ///
+ /// a linked company, such as their address, phone number, and company registration. ///
public class CommerceCompanyInfo { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -32,78 +27,73 @@ public class CommerceCompanyInfo public string? SourceModifiedDate { get; set; } /// - /// The name of the company + /// The name of the company. /// [JsonProperty("companyName")] public string? CompanyName { get; set; } /// - /// Identifier or reference for the company in the commerce software + /// Identifier or reference for the company in the commerce software. /// [JsonProperty("commercePlatformRef")] public string? CommercePlatformRef { get; set; } /// - /// The full legal name of the company + /// The full legal name of the company. /// [JsonProperty("companyLegalName")] public string? CompanyLegalName { get; set; } /// - /// Addresses associated with the company + /// Addresses associated with the company. /// [JsonProperty("addresses")] public List? Addresses { get; set; } /// - /// Phone numbers associated with the company + /// Phone numbers associated with the company. /// [JsonProperty("phoneNumbers")] public List? PhoneNumbers { get; set; } /// - /// Weblinks associated with the company + /// Weblinks associated with the company. /// [JsonProperty("webLinks")] public List? WebLinks { get; set; } /// - /// The registration number of the company + /// The registration number of the company. /// [JsonProperty("registrationNumber")] public string? RegistrationNumber { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("baseCurrency")] public string? BaseCurrency { get; set; } /// - /// The available and current cash balances for the company's accounts + /// The available and current cash balances for the company's accounts. /// [JsonProperty("accountBalances")] public List? AccountBalances { get; set; } /// - /// URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system + /// URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system. /// [JsonProperty("sourceUrls")] public Dictionary? SourceUrls { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -122,7 +112,6 @@ public class CommerceCompanyInfo /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceCustomer.cs b/lending/Codat/Lending/Models/Components/CommerceCustomer.cs index 82691b8d8..5e27d6442 100644 --- a/lending/Codat/Lending/Models/Components/CommerceCustomer.cs +++ b/lending/Codat/Lending/Models/Components/CommerceCustomer.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn. /// public class CommerceCustomer { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -27,19 +26,19 @@ public class CommerceCustomer public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// Name of the customer + /// Name of the customer. /// [JsonProperty("customerName")] public string? CustomerName { get; set; } /// - /// Email address of the customer + /// Email address of the customer. /// [JsonProperty("emailAddress")] public string? EmailAddress { get; set; } @@ -54,21 +53,19 @@ public class CommerceCustomer public string? DefaultCurrency { get; set; } /// - /// Addresses of the customer + /// Addresses of the customer. /// [JsonProperty("addresses")] public List? Addresses { get; set; } /// - /// Any additional information about the customer + /// Any additional information about the customer. /// [JsonProperty("note")] public string? Note { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -87,7 +84,6 @@ public class CommerceCustomer /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceCustomerRef.cs b/lending/Codat/Lending/Models/Components/CommerceCustomerRef.cs index a9749d525..8003fadd3 100644 --- a/lending/Codat/Lending/Models/Components/CommerceCustomerRef.cs +++ b/lending/Codat/Lending/Models/Components/CommerceCustomerRef.cs @@ -11,15 +11,14 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference to the customer that placed the order. /// public class CommerceCustomerRef { - /// - /// The unique identitifer of the customer being referenced + /// The unique identitifer of the customer being referenced. /// [JsonProperty("id")] public string Id { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/CommerceCustomers.cs b/lending/Codat/Lending/Models/Components/CommerceCustomers.cs index cbf3a8013..4bd61f314 100644 --- a/lending/Codat/Lending/Models/Components/CommerceCustomers.cs +++ b/lending/Codat/Lending/Models/Components/CommerceCustomers.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceCustomers { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceDispute.cs b/lending/Codat/Lending/Models/Components/CommerceDispute.cs index 84f3e8f25..4e4318001 100644 --- a/lending/Codat/Lending/Models/Components/CommerceDispute.cs +++ b/lending/Codat/Lending/Models/Components/CommerceDispute.cs @@ -13,21 +13,17 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example:
- /// - /// - /// - They didn't receive an order.
- /// - The product they received was different to the commerce store's description.
- /// - They've been the victim of online fraud.
+ /// A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example:
+ /// - They didn't receive an order.
+ /// - The product they received was different to the commerce store's description.
+ /// - They've been the victim of online fraud.
///
/// You can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks. - ///
///
public class CommerceDispute { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -35,7 +31,7 @@ public class CommerceDispute public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; @@ -54,35 +50,30 @@ public class CommerceDispute /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; /// - /// Current status of the dispute + /// Current status of the dispute. /// [JsonProperty("status")] public DisputeStatus? Status { get; set; } /// - /// Reason for the dispute + /// Reason for the dispute. /// [JsonProperty("reason")] public string? Reason { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -101,15 +92,12 @@ public class CommerceDispute /// >
/// > 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. - ///
///
[JsonProperty("dueDate")] public string? DueDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -128,7 +116,6 @@ public class CommerceDispute /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceDisputes.cs b/lending/Codat/Lending/Models/Components/CommerceDisputes.cs index 000da4cd2..793463f12 100644 --- a/lending/Codat/Lending/Models/Components/CommerceDisputes.cs +++ b/lending/Codat/Lending/Models/Components/CommerceDisputes.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceDisputes { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceLocation.cs b/lending/Codat/Lending/Models/Components/CommerceLocation.cs index 2566dea51..81f812282 100644 --- a/lending/Codat/Lending/Models/Components/CommerceLocation.cs +++ b/lending/Codat/Lending/Models/Components/CommerceLocation.cs @@ -12,18 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type.
- /// - /// ///
/// A Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type. - ///
///
public class CommerceLocation { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -31,13 +27,13 @@ public class CommerceLocation public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// Name of this location + /// Name of this location. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceLocations.cs b/lending/Codat/Lending/Models/Components/CommerceLocations.cs index 131e99caa..bf890bfa7 100644 --- a/lending/Codat/Lending/Models/Components/CommerceLocations.cs +++ b/lending/Codat/Lending/Models/Components/CommerceLocations.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceLocations { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceOrder.cs b/lending/Codat/Lending/Models/Components/CommerceOrder.cs index f183dca1d..e0c9fb8e3 100644 --- a/lending/Codat/Lending/Models/Components/CommerceOrder.cs +++ b/lending/Codat/Lending/Models/Components/CommerceOrder.cs @@ -13,17 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR).
- /// - /// - /// - /// + /// Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). ///
public class CommerceOrder { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -31,7 +26,7 @@ public class CommerceOrder public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; @@ -44,13 +39,10 @@ public class CommerceOrder /// /// The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.
- /// - /// ///
- /// Depending on the platform the value of this property will either be an <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">ISO 3166</a> code (2-alpha or 3-alpha) or free-form text returned as a string name in our model.
+ /// Depending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model.
///
/// For POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the options endpoint. - ///
///
[JsonProperty("country")] public string? Country { get; set; } @@ -59,9 +51,7 @@ public class CommerceOrder public string? Currency { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -80,7 +70,6 @@ public class CommerceOrder /// >
/// > 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. - ///
///
[JsonProperty("closedDate")] public string? ClosedDate { get; set; } @@ -138,19 +127,14 @@ public class CommerceOrder /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -169,7 +153,6 @@ public class CommerceOrder /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceOrders.cs b/lending/Codat/Lending/Models/Components/CommerceOrders.cs index 14ebf071d..218936883 100644 --- a/lending/Codat/Lending/Models/Components/CommerceOrders.cs +++ b/lending/Codat/Lending/Models/Components/CommerceOrders.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceOrders { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommercePayment.cs b/lending/Codat/Lending/Models/Components/CommercePayment.cs index b60fb98a0..312fb17aa 100644 --- a/lending/Codat/Lending/Models/Components/CommercePayment.cs +++ b/lending/Codat/Lending/Models/Components/CommercePayment.cs @@ -12,20 +12,16 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status.
- /// - /// ///
/// Refunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`.
///
/// You can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR). - ///
///
public class CommercePayment { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -33,28 +29,25 @@ public class CommercePayment public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// Payment Amount (including gratuity) + /// Payment Amount (including gratuity). /// [JsonProperty("amount")] public decimal? Amount { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -78,9 +71,7 @@ public class CommercePayment public string? PaymentProvider { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -99,26 +90,20 @@ public class CommercePayment /// >
/// > 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. - ///
///
[JsonProperty("dueDate")] public string? DueDate { get; set; } /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -137,7 +122,6 @@ public class CommercePayment /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommercePaymentMethod.cs b/lending/Codat/Lending/Models/Components/CommercePaymentMethod.cs index 2f555f2ec..f3932a53f 100644 --- a/lending/Codat/Lending/Models/Components/CommercePaymentMethod.cs +++ b/lending/Codat/Lending/Models/Components/CommercePaymentMethod.cs @@ -12,13 +12,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// A Payment Method represents the payment method(s) used to make payments. /// public class CommercePaymentMethod { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -26,13 +25,13 @@ public class CommercePaymentMethod public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// The name of the PaymentMethod + /// The name of the PaymentMethod. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommercePaymentMethodStatus.cs b/lending/Codat/Lending/Models/Components/CommercePaymentMethodStatus.cs index ebeb71f7b..2e166530c 100644 --- a/lending/Codat/Lending/Models/Components/CommercePaymentMethodStatus.cs +++ b/lending/Codat/Lending/Models/Components/CommercePaymentMethodStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the Payment Method. /// @@ -58,5 +58,4 @@ public static CommercePaymentMethodStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CommercePaymentMethodStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/CommercePaymentMethods.cs b/lending/Codat/Lending/Models/Components/CommercePaymentMethods.cs index d1bb12e9d..6f56a8397 100644 --- a/lending/Codat/Lending/Models/Components/CommercePaymentMethods.cs +++ b/lending/Codat/Lending/Models/Components/CommercePaymentMethods.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommercePaymentMethods { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommercePayments.cs b/lending/Codat/Lending/Models/Components/CommercePayments.cs index f34b26540..4c2680b2f 100644 --- a/lending/Codat/Lending/Models/Components/CommercePayments.cs +++ b/lending/Codat/Lending/Models/Components/CommercePayments.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommercePayments { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceProduct.cs b/lending/Codat/Lending/Models/Components/CommerceProduct.cs index 97e9bdd58..a21f428d7 100644 --- a/lending/Codat/Lending/Models/Components/CommerceProduct.cs +++ b/lending/Codat/Lending/Models/Components/CommerceProduct.cs @@ -13,25 +13,20 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale.
- /// - /// - /// - /// + /// A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. ///
public class CommerceProduct { - /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// Name of the product in the commerce or POS system + /// Name of the product in the commerce or POS system. /// [JsonProperty("name")] public string? Name { get; set; } @@ -50,11 +45,7 @@ public class CommerceProduct /// /// Whether the product represents a gift card or voucher that
- /// - /// - /// can be redeemed in the commerce or POS platform.
- /// - ///
+ /// can be redeemed in the commerce or POS platform. ///
[JsonProperty("isGiftCard")] public bool? IsGiftCard { get; set; } @@ -64,11 +55,8 @@ public class CommerceProduct /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceProductCategories.cs b/lending/Codat/Lending/Models/Components/CommerceProductCategories.cs index c996a0552..3efff1ac9 100644 --- a/lending/Codat/Lending/Models/Components/CommerceProductCategories.cs +++ b/lending/Codat/Lending/Models/Components/CommerceProductCategories.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceProductCategories { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceProductCategory.cs b/lending/Codat/Lending/Models/Components/CommerceProductCategory.cs index ad81afaea..a31a1b5d8 100644 --- a/lending/Codat/Lending/Models/Components/CommerceProductCategory.cs +++ b/lending/Codat/Lending/Models/Components/CommerceProductCategory.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. /// public class CommerceProductCategory { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -27,13 +26,13 @@ public class CommerceProductCategory public string? SourceModifiedDate { get; set; } /// - /// The unique identifier of the product category + /// The unique identifier of the product category. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// The name of the product category + /// The name of the product category. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceProducts.cs b/lending/Codat/Lending/Models/Components/CommerceProducts.cs index e48a4f015..635bfb639 100644 --- a/lending/Codat/Lending/Models/Components/CommerceProducts.cs +++ b/lending/Codat/Lending/Models/Components/CommerceProducts.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceProducts { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceRecordRef.cs b/lending/Codat/Lending/Models/Components/CommerceRecordRef.cs index 6a4014bcf..3241d94f2 100644 --- a/lending/Codat/Lending/Models/Components/CommerceRecordRef.cs +++ b/lending/Codat/Lending/Models/Components/CommerceRecordRef.cs @@ -11,12 +11,11 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CommerceRecordRef { - /// - /// The unique identitifer of the record being referenced + /// The unique identitifer of the record being referenced. /// [JsonProperty("id")] public string Id { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/CommerceReport.cs b/lending/Codat/Lending/Models/Components/CommerceReport.cs index 77bfcf3b1..b734a997e 100644 --- a/lending/Codat/Lending/Models/Components/CommerceReport.cs +++ b/lending/Codat/Lending/Models/Components/CommerceReport.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// ## Structure
- /// - /// ///
/// Assess reports follow a consistent structure. Reports contain four sections of information:
///
@@ -34,7 +32,7 @@ namespace Codat.Lending.Models.Components ///
/// 1. The type of dimension (e.g. datetime, recordRef).
/// 2. The display name of the dimension (e.g. Period, Category type, Category sub type).
- /// 3. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"...").
+ /// 3. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"...").
///
/// ### 3. Measure info
///
@@ -53,16 +51,14 @@ namespace Codat.Lending.Models.Components ///
/// Reports can be rendered as follows (ordering is implicit rather than explicit):
///
- /// !A table showing an example of how a report can be rendered
+ /// !A table showing an example of how a report can be rendered ///
/// # Data model
///
- /// ## Dimensions - ///
+ /// ## Dimensions. ///
public class CommerceReport { - [JsonProperty("reportInfo")] public Dictionary? ReportInfo { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceReportComponent.cs b/lending/Codat/Lending/Models/Components/CommerceReportComponent.cs index ca06c340a..f236922fa 100644 --- a/lending/Codat/Lending/Models/Components/CommerceReportComponent.cs +++ b/lending/Codat/Lending/Models/Components/CommerceReportComponent.cs @@ -13,30 +13,29 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceReportComponent { - /// - /// The component's dimension. + /// The component's dimension. /// [JsonProperty("dimension")] public long? Dimension { get; set; } /// - /// The component's display name. + /// The component's display name. /// [JsonProperty("dimensionDisplayName")] public string? DimensionDisplayName { get; set; } /// - /// The component's item number. + /// The component's item number. /// [JsonProperty("item")] public long? Item { get; set; } /// - /// The component's item display name. + /// The component's item display name. /// [JsonProperty("itemDisplayName")] public string? ItemDisplayName { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceReportDimension.cs b/lending/Codat/Lending/Models/Components/CommerceReportDimension.cs index 3b0b943d1..339b3265a 100644 --- a/lending/Codat/Lending/Models/Components/CommerceReportDimension.cs +++ b/lending/Codat/Lending/Models/Components/CommerceReportDimension.cs @@ -13,24 +13,23 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceReportDimension { - /// - /// The dimension's index. + /// The dimension's index. /// [JsonProperty("index")] public long? Index { get; set; } /// - /// The dimension's display name. + /// The dimension's display name. /// [JsonProperty("displayName")] public string? DisplayName { get; set; } /// - /// The dimension's type. + /// The dimension's type. /// [JsonProperty("type")] public string? Type { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceReportDimensionItems.cs b/lending/Codat/Lending/Models/Components/CommerceReportDimensionItems.cs index 3d7a8a98c..e37036176 100644 --- a/lending/Codat/Lending/Models/Components/CommerceReportDimensionItems.cs +++ b/lending/Codat/Lending/Models/Components/CommerceReportDimensionItems.cs @@ -11,12 +11,11 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CommerceReportDimensionItems { - /// - /// The dimension's items index. + /// The dimension's items index. /// [JsonProperty("index")] public long? Index { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceReportError.cs b/lending/Codat/Lending/Models/Components/CommerceReportError.cs index 0b837e9f9..b9d395d18 100644 --- a/lending/Codat/Lending/Models/Components/CommerceReportError.cs +++ b/lending/Codat/Lending/Models/Components/CommerceReportError.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceReportError { - /// /// Message returned by error. /// diff --git a/lending/Codat/Lending/Models/Components/CommerceReportMeasure.cs b/lending/Codat/Lending/Models/Components/CommerceReportMeasure.cs index b3996ca67..c4897f868 100644 --- a/lending/Codat/Lending/Models/Components/CommerceReportMeasure.cs +++ b/lending/Codat/Lending/Models/Components/CommerceReportMeasure.cs @@ -11,30 +11,29 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CommerceReportMeasure { - /// - /// The measure's display name. + /// The measure's display name. /// [JsonProperty("displayName")] public string? DisplayName { get; set; } /// - /// The measure's units e.g. percentage (%). + /// The measure's units e.g. percentage (%). /// [JsonProperty("units")] public string? Units { get; set; } /// - /// The measure's index. + /// The measure's index. /// [JsonProperty("index")] public long? Index { get; set; } /// - /// The measure's type. + /// The measure's type. /// [JsonProperty("type")] public string? Type { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceTransaction.cs b/lending/Codat/Lending/Models/Components/CommerceTransaction.cs index 2728fe28d..911ddc76b 100644 --- a/lending/Codat/Lending/Models/Components/CommerceTransaction.cs +++ b/lending/Codat/Lending/Models/Components/CommerceTransaction.cs @@ -12,27 +12,21 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees.
- /// - /// ///
/// You can use data from the Transactions endpoints to calculate key metrics, such as:
/// - Transaction volumes
/// - Average transaction volume
/// - Average transaction value
/// - Returns
- /// - Payouts - ///
+ /// - Payouts. ///
public class CommerceTransaction { - /// - /// 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:
- /// - /// + /// 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
@@ -51,15 +45,12 @@ public class CommerceTransaction /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -78,7 +69,6 @@ public class CommerceTransaction /// >
/// > 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. - ///
///
[JsonProperty("sourceCreatedDate")] public string? SourceCreatedDate { get; set; } @@ -90,68 +80,59 @@ public class CommerceTransaction public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// The total transaction amount + /// The total transaction amount. /// [JsonProperty("totalAmount")] public decimal? TotalAmount { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// The type of the platform transaction:
- /// - /// /// - `Unknown`
- /// - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
+ /// - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
/// - `Payment` — Credit and debit card payments.
- /// - `PaymentFee` — Payment provider's fee on each card payment.
- /// - `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
- /// - `Payout` — Transfer of funds from the seller's merchant account to their bank account.
- /// - `Refund` — Refunds to a customer's credit or debit card.
- /// - `Transfer` — Secure transfer of funds to the seller's bank account. - ///
+ /// - `PaymentFee` — Payment provider's fee on each card payment.
+ /// - `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
+ /// - `Payout` — Transfer of funds from the seller's merchant account to their bank account.
+ /// - `Refund` — Refunds to a customer's credit or debit card.
+ /// - `Transfer` — Secure transfer of funds to the seller's bank account. ///
[JsonProperty("type")] public TransactionType? Type { get; set; } /// - /// Non-standardised transaction type data from the commerce software + /// Non-standardised transaction type data from the commerce software. /// [JsonProperty("subType")] public string? SubType { get; set; } /// - /// Link to the source event which triggered this transaction + /// Link to the source event which triggered this transaction. /// [JsonProperty("transactionSourceRef")] public TransactionSourceRef? TransactionSourceRef { get; set; } /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CommerceTransactions.cs b/lending/Codat/Lending/Models/Components/CommerceTransactions.cs index 6fedb4244..47679d1a2 100644 --- a/lending/Codat/Lending/Models/Components/CommerceTransactions.cs +++ b/lending/Codat/Lending/Models/Components/CommerceTransactions.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CommerceTransactions { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Companies.cs b/lending/Codat/Lending/Models/Components/Companies.cs index 614c80fe4..3c77e7220 100644 --- a/lending/Codat/Lending/Models/Components/Companies.cs +++ b/lending/Codat/Lending/Models/Components/Companies.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Companies { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Company.cs b/lending/Codat/Lending/Models/Components/Company.cs index 575f263d6..c2fea1d73 100644 --- a/lending/Codat/Lending/Models/Components/Company.cs +++ b/lending/Codat/Lending/Models/Components/Company.cs @@ -13,20 +13,16 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// In Codat, a company represents a business sharing access to their data. Each company can have multiple connections 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.
- /// - /// ///
/// Typically each company is one of your customers.
///
/// When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company. - ///
///
public class Company { - /// /// Unique identifier for your SMB in Codat. /// @@ -34,7 +30,7 @@ public class Company public string Id { get; set; } = default!; /// - /// The name of the company + /// The name of the company. /// [JsonProperty("name")] public string Name { get; set; } = default!; @@ -52,9 +48,7 @@ public class Company public string Redirect { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -73,15 +67,12 @@ public class Company /// >
/// > 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. - ///
///
[JsonProperty("lastSync")] public string? LastSync { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -100,7 +91,6 @@ public class Company /// >
/// > 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. - ///
///
[JsonProperty("created")] public string? Created { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CompanyReference.cs b/lending/Codat/Lending/Models/Components/CompanyReference.cs index efae7e22a..72484d2df 100644 --- a/lending/Codat/Lending/Models/Components/CompanyReference.cs +++ b/lending/Codat/Lending/Models/Components/CompanyReference.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CompanyReference { - /// /// Unique identifier for your SMB in Codat. /// @@ -24,7 +23,7 @@ public class CompanyReference public string? Id { get; set; } /// - /// The name of the company + /// The name of the company. /// [JsonProperty("name")] public string? Name { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CompanyReferenceLinks.cs b/lending/Codat/Lending/Models/Components/CompanyReferenceLinks.cs index 982c29f24..7b6853119 100644 --- a/lending/Codat/Lending/Models/Components/CompanyReferenceLinks.cs +++ b/lending/Codat/Lending/Models/Components/CompanyReferenceLinks.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// A collection of links for the company. /// public class CompanyReferenceLinks { - /// /// Link to the company page in the portal. /// diff --git a/lending/Codat/Lending/Models/Components/CompanyRequestBody.cs b/lending/Codat/Lending/Models/Components/CompanyRequestBody.cs index fee274419..370c6ca34 100644 --- a/lending/Codat/Lending/Models/Components/CompanyRequestBody.cs +++ b/lending/Codat/Lending/Models/Components/CompanyRequestBody.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CompanyRequestBody { - /// /// Name of company being connected. /// diff --git a/lending/Codat/Lending/Models/Components/CompanyUpdateRequest.cs b/lending/Codat/Lending/Models/Components/CompanyUpdateRequest.cs index 282047777..598d3e84d 100644 --- a/lending/Codat/Lending/Models/Components/CompanyUpdateRequest.cs +++ b/lending/Codat/Lending/Models/Components/CompanyUpdateRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class CompanyUpdateRequest { - /// /// Name of company being connected. /// diff --git a/lending/Codat/Lending/Models/Components/Connection.cs b/lending/Codat/Lending/Models/Components/Connection.cs index a89a28d40..6a329fb2b 100644 --- a/lending/Codat/Lending/Models/Components/Connection.cs +++ b/lending/Codat/Lending/Models/Components/Connection.cs @@ -13,11 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// A connection represents a company's connection to a data source and allows you to synchronize data (pull and/or push) with that source.
- /// - /// + /// A connection represents a company's connection to a data source and allows you to synchronize data (pull and/or push) with that source.
///
/// A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
///
@@ -27,13 +25,11 @@ namespace Codat.Lending.Models.Components /// Any combination of accounting, banking, and commerce data connections is allowed.
///
/// Before you can use a data connection to pull or push data, the company must grant you access to their business data by linking the connection. - ///
///
public class Connection { - /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("id")] public string Id { get; set; } = default!; @@ -45,7 +41,7 @@ public class Connection public string IntegrationId { get; set; } = default!; /// - /// 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. + /// 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. /// [JsonProperty("integrationKey")] public string IntegrationKey { get; set; } = default!; @@ -81,9 +77,7 @@ public class Connection public DataConnectionStatus Status { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -102,15 +96,12 @@ public class Connection /// >
/// > 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. - ///
///
[JsonProperty("lastSync")] public string? LastSync { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -129,7 +120,6 @@ public class Connection /// >
/// > 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. - ///
///
[JsonProperty("created")] public string Created { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/Connections.cs b/lending/Codat/Lending/Models/Components/Connections.cs index 3a688a512..69a6796eb 100644 --- a/lending/Codat/Lending/Models/Components/Connections.cs +++ b/lending/Codat/Lending/Models/Components/Connections.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Connections { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Contact.cs b/lending/Codat/Lending/Models/Components/Contact.cs index db4adfaba..2066213a9 100644 --- a/lending/Codat/Lending/Models/Components/Contact.cs +++ b/lending/Codat/Lending/Models/Components/Contact.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Contact { - /// /// Name of a contact for a customer. /// @@ -45,9 +44,7 @@ public class Contact public CustomerStatus Status { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -66,7 +63,6 @@ public class Contact /// >
/// > 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. - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ContactRef.cs b/lending/Codat/Lending/Models/Components/ContactRef.cs index d80d1a7a4..2b83389f6 100644 --- a/lending/Codat/Lending/Models/Components/ContactRef.cs +++ b/lending/Codat/Lending/Models/Components/ContactRef.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ContactRef { - /// /// Unique identifier for a customer or supplier. /// @@ -23,7 +22,7 @@ public class ContactRef public string Id { get; set; } = default!; /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// [JsonProperty("dataType")] public ContactRefDataType? DataType { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/ContactRefDataType.cs b/lending/Codat/Lending/Models/Components/ContactRefDataType.cs index b7b336d27..7866823b8 100644 --- a/lending/Codat/Lending/Models/Components/ContactRefDataType.cs +++ b/lending/Codat/Lending/Models/Components/ContactRefDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// public enum ContactRefDataType { @@ -56,5 +56,4 @@ public static ContactRefDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ContactRefDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ContactReference.cs b/lending/Codat/Lending/Models/Components/ContactReference.cs index 04e479e4a..76c007a01 100644 --- a/lending/Codat/Lending/Models/Components/ContactReference.cs +++ b/lending/Codat/Lending/Models/Components/ContactReference.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ContactReference { - /// /// Unique identifier for a customer or supplier. /// @@ -23,7 +22,7 @@ public class ContactReference public string Id { get; set; } = default!; /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// [JsonProperty("dataType")] public JournalLineDataType? DataType { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/CreateBankAccountTransaction.cs b/lending/Codat/Lending/Models/Components/CreateBankAccountTransaction.cs index c86df30a7..4c2b21561 100644 --- a/lending/Codat/Lending/Models/Components/CreateBankAccountTransaction.cs +++ b/lending/Codat/Lending/Models/Components/CreateBankAccountTransaction.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CreateBankAccountTransaction { - /// /// Identifier for the bank account transaction, unique for the company in the accounting software. /// @@ -28,9 +27,7 @@ public class CreateBankAccountTransaction public decimal? Amount { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -49,7 +46,6 @@ public class CreateBankAccountTransaction /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CreditNoteLineItem.cs b/lending/Codat/Lending/Models/Components/CreditNoteLineItem.cs index 8cc69aaa9..b0302602a 100644 --- a/lending/Codat/Lending/Models/Components/CreditNoteLineItem.cs +++ b/lending/Codat/Lending/Models/Components/CreditNoteLineItem.cs @@ -14,10 +14,9 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class CreditNoteLineItem { - /// /// Friendly name of each line item. For example, the goods or service for which credit has been issued. /// @@ -74,8 +73,6 @@ public class CreditNoteLineItem /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -84,8 +81,7 @@ public class CreditNoteLineItem /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
[JsonProperty("taxRateRef")] public TaxRateRef? TaxRateRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/CreditNoteStatus.cs b/lending/Codat/Lending/Models/Components/CreditNoteStatus.cs index 7c4e38fda..29e25681f 100644 --- a/lending/Codat/Lending/Models/Components/CreditNoteStatus.cs +++ b/lending/Codat/Lending/Models/Components/CreditNoteStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Current state of the credit note. /// @@ -64,5 +64,4 @@ public static CreditNoteStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CreditNoteStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/CustomerStatus.cs b/lending/Codat/Lending/Models/Components/CustomerStatus.cs index cec4a1e6f..5d82267be 100644 --- a/lending/Codat/Lending/Models/Components/CustomerStatus.cs +++ b/lending/Codat/Lending/Models/Components/CustomerStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of customer. /// @@ -58,5 +58,4 @@ public static CustomerStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum CustomerStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/DataConnectionError.cs b/lending/Codat/Lending/Models/Components/DataConnectionError.cs index a5d8d61b2..c83cec075 100644 --- a/lending/Codat/Lending/Models/Components/DataConnectionError.cs +++ b/lending/Codat/Lending/Models/Components/DataConnectionError.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataConnectionError { - /// /// The HTTP status code returned by the source platform when the error occurred. /// @@ -35,9 +34,7 @@ public class DataConnectionError public string? ErrorMessage { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -56,7 +53,6 @@ public class DataConnectionError /// >
/// > 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. - ///
///
[JsonProperty("erroredOnUtc")] public string? ErroredOnUtc { get; set; } @@ -68,9 +64,7 @@ public class DataConnectionError public ErrorStatus? Status { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -89,7 +83,6 @@ public class DataConnectionError /// >
/// > 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. - ///
///
[JsonProperty("resolvedOnUtc")] public string? ResolvedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataConnectionStatus.cs b/lending/Codat/Lending/Models/Components/DataConnectionStatus.cs index e3d8ec19a..53bf48dff 100644 --- a/lending/Codat/Lending/Models/Components/DataConnectionStatus.cs +++ b/lending/Codat/Lending/Models/Components/DataConnectionStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The current authorization status of the data connection. /// @@ -60,5 +60,4 @@ public static DataConnectionStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataConnectionStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityAmounts.cs b/lending/Codat/Lending/Models/Components/DataIntegrityAmounts.cs index 1749b7d59..518d62dee 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityAmounts.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityAmounts.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Only returned for transactions. For accounts, there is nothing returned. /// public class DataIntegrityAmounts { - /// /// Lowest value of transaction set. /// @@ -32,15 +31,12 @@ public class DataIntegrityAmounts /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityByAmount.cs b/lending/Codat/Lending/Models/Components/DataIntegrityByAmount.cs index 9c23bded5..8fcabc846 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityByAmount.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityByAmount.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataIntegrityByAmount { - /// /// The percentage of the absolute value of transactions of the type specified in the route which have a match. /// @@ -22,7 +21,7 @@ public class DataIntegrityByAmount public decimal? MatchPercentage { get; set; } /// - /// The sum of the absolute value of transactions of the type specified in the route which don't have a match. + /// The sum of the absolute value of transactions of the type specified in the route which don't have a match. /// [JsonProperty("unmatched")] public decimal? Unmatched { get; set; } @@ -41,15 +40,12 @@ public class DataIntegrityByAmount /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityByCount.cs b/lending/Codat/Lending/Models/Components/DataIntegrityByCount.cs index 030605b92..aeb78b962 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityByCount.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityByCount.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataIntegrityByCount { - /// /// The percentage of records of the type specified in the route which have a match. /// @@ -22,7 +21,7 @@ public class DataIntegrityByCount public decimal? MatchPercentage { get; set; } /// - /// The number of records of the type specified in the route which don't have a match. + /// The number of records of the type specified in the route which don't have a match. /// [JsonProperty("unmatched")] public decimal? Unmatched { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityConnectionId.cs b/lending/Codat/Lending/Models/Components/DataIntegrityConnectionId.cs index 9756c860f..0257868e3 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityConnectionId.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityConnectionId.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DataIntegrityConnectionId { - /// /// An array of strings. The connection IDs for the type specified in the url. /// diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityDataType.cs b/lending/Codat/Lending/Models/Components/DataIntegrityDataType.cs index 60b6284eb..9d3f4f457 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityDataType.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityDataType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + public enum DataIntegrityDataType { [JsonProperty("banking-accounts")] @@ -57,5 +57,4 @@ public static DataIntegrityDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataIntegrityDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityDates.cs b/lending/Codat/Lending/Models/Components/DataIntegrityDates.cs index c0a43d49e..909b85f85 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityDates.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityDates.cs @@ -11,17 +11,14 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Only returned for transactions. For accounts, there is nothing returned. /// public class DataIntegrityDates { - /// - /// 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:
- /// - /// + /// 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
@@ -40,15 +37,12 @@ public class DataIntegrityDates /// >
/// > 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. - ///
///
[JsonProperty("minDate")] public string? MinDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -67,15 +61,12 @@ public class DataIntegrityDates /// >
/// > 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. - ///
///
[JsonProperty("maxDate")] public string? MaxDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -94,15 +85,12 @@ public class DataIntegrityDates /// >
/// > 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. - ///
///
[JsonProperty("minOverlappingDate")] public string? MinOverlappingDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -121,7 +109,6 @@ public class DataIntegrityDates /// >
/// > 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. - ///
///
[JsonProperty("maxOverlappingDate")] public string? MaxOverlappingDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityDetail.cs b/lending/Codat/Lending/Models/Components/DataIntegrityDetail.cs index 2dfaa33b0..72ba17207 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityDetail.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityDetail.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DataIntegrityDetail { - /// /// ID GUID of the transaction. /// @@ -36,9 +35,7 @@ public class DataIntegrityDetail public string? ConnectionId { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -57,7 +54,6 @@ public class DataIntegrityDetail /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } @@ -76,15 +72,12 @@ public class DataIntegrityDetail /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityDetails.cs b/lending/Codat/Lending/Models/Components/DataIntegrityDetails.cs index cbcfaffc2..df76c7ec2 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityDetails.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityDetails.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DataIntegrityDetails { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityMatch.cs b/lending/Codat/Lending/Models/Components/DataIntegrityMatch.cs index b4f6811af..aceff2d6c 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityMatch.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityMatch.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataIntegrityMatch { - /// /// ID GUID of the transaction. /// @@ -22,7 +21,7 @@ public class DataIntegrityMatch public string? Id { get; set; } /// - /// The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. + /// The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. /// [JsonProperty("type")] public string? Type { get; set; } @@ -53,15 +52,12 @@ public class DataIntegrityMatch /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityStatus.cs b/lending/Codat/Lending/Models/Components/DataIntegrityStatus.cs index 2df1ebd00..9b39a5fa4 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityStatus.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityStatus.cs @@ -12,12 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataIntegrityStatus { - /// - /// The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. + /// The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. /// [JsonProperty("type")] public string? Type { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityStatusInfo.cs b/lending/Codat/Lending/Models/Components/DataIntegrityStatusInfo.cs index e2db6f541..5ea1f6c96 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityStatusInfo.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityStatusInfo.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataIntegrityStatusInfo { - /// - /// 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:
- /// - /// + /// 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
@@ -38,7 +35,6 @@ public class DataIntegrityStatusInfo /// >
/// > 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. - ///
///
[JsonProperty("lastMatched")] public string? LastMatched { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataIntegrityStatuses.cs b/lending/Codat/Lending/Models/Components/DataIntegrityStatuses.cs index 657d24ffc..38fb28582 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegrityStatuses.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegrityStatuses.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DataIntegrityStatuses { - [JsonProperty("metadata")] public List? Metadata { get; set; } } diff --git a/lending/Codat/Lending/Models/Components/DataIntegritySummaries.cs b/lending/Codat/Lending/Models/Components/DataIntegritySummaries.cs index 22dd8de10..38cd977aa 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegritySummaries.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegritySummaries.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DataIntegritySummaries { - [JsonProperty("summaries")] public List? Summaries { get; set; } } diff --git a/lending/Codat/Lending/Models/Components/DataIntegritySummary.cs b/lending/Codat/Lending/Models/Components/DataIntegritySummary.cs index 0c88df823..3b1bbf133 100644 --- a/lending/Codat/Lending/Models/Components/DataIntegritySummary.cs +++ b/lending/Codat/Lending/Models/Components/DataIntegritySummary.cs @@ -12,12 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class DataIntegritySummary { - /// - /// The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. + /// The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. /// [JsonProperty("type")] public string? Type { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataSource.cs b/lending/Codat/Lending/Models/Components/DataSource.cs index 12eb74bd9..586077db0 100644 --- a/lending/Codat/Lending/Models/Components/DataSource.cs +++ b/lending/Codat/Lending/Models/Components/DataSource.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DataSource { - /// /// An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`. /// diff --git a/lending/Codat/Lending/Models/Components/DataStatus.cs b/lending/Codat/Lending/Models/Components/DataStatus.cs index 561e8a708..6936b07aa 100644 --- a/lending/Codat/Lending/Models/Components/DataStatus.cs +++ b/lending/Codat/Lending/Models/Components/DataStatus.cs @@ -12,23 +12,20 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// public class DataStatus { - /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public DataTypes DataType { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -47,7 +44,6 @@ public class DataStatus /// >
/// > 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. - ///
///
[JsonProperty("lastSuccessfulSync")] public string? LastSuccessfulSync { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DataType.cs b/lending/Codat/Lending/Models/Components/DataType.cs index 973f471e3..9d5826dae 100644 --- a/lending/Codat/Lending/Models/Components/DataType.cs +++ b/lending/Codat/Lending/Models/Components/DataType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Available data types + /// Available data types. /// public enum DataType { @@ -138,5 +138,4 @@ public static DataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/DataTypes.cs b/lending/Codat/Lending/Models/Components/DataTypes.cs index 33a7918d8..80c0493f4 100644 --- a/lending/Codat/Lending/Models/Components/DataTypes.cs +++ b/lending/Codat/Lending/Models/Components/DataTypes.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Available data types + /// Available data types. /// public enum DataTypes { @@ -138,5 +138,4 @@ public static DataTypes ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataTypes"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/DatasetStatus.cs b/lending/Codat/Lending/Models/Components/DatasetStatus.cs index 15a0d2657..6d148f752 100644 --- a/lending/Codat/Lending/Models/Components/DatasetStatus.cs +++ b/lending/Codat/Lending/Models/Components/DatasetStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the dataset. /// @@ -94,5 +94,4 @@ public static DatasetStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DatasetStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/DirectCostLineItem.cs b/lending/Codat/Lending/Models/Components/DirectCostLineItem.cs index 91befa56c..48fcd8bcb 100644 --- a/lending/Codat/Lending/Models/Components/DirectCostLineItem.cs +++ b/lending/Codat/Lending/Models/Components/DirectCostLineItem.cs @@ -14,10 +14,9 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class DirectCostLineItem { - /// /// Friendly name of the goods or services. /// @@ -26,21 +25,15 @@ public class DirectCostLineItem /// /// Price of each unit of goods or services.
- /// - /// /// Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. - /// ///
[JsonProperty("unitAmount")] public decimal UnitAmount { get; set; } = default!; /// /// Number of units of goods or services received.
- /// - /// ///
/// Note: If the platform does not provide this information, the quantity will be mapped as 1. - ///
///
[JsonProperty("quantity")] public decimal Quantity { get; set; } = default!; @@ -83,8 +76,6 @@ public class DirectCostLineItem /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -93,8 +84,7 @@ public class DirectCostLineItem /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
[JsonProperty("taxRateRef")] public TaxRateRef? TaxRateRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DirectCostPrototype.cs b/lending/Codat/Lending/Models/Components/DirectCostPrototype.cs index 0b29a116f..c6d137be6 100644 --- a/lending/Codat/Lending/Models/Components/DirectCostPrototype.cs +++ b/lending/Codat/Lending/Models/Components/DirectCostPrototype.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DirectCostPrototype { - /// /// User-friendly reference for the direct cost. /// @@ -33,9 +32,7 @@ public class DirectCostPrototype public ContactRef? ContactRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -54,34 +51,28 @@ public class DirectCostPrototype /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string IssueDate { get; set; } = default!; /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; /// /// 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.
+ /// 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).
///
@@ -109,7 +100,6 @@ public class DirectCostPrototype /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; @@ -146,11 +136,8 @@ public class DirectCostPrototype /// /// 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 about supplemental data. - ///
///
[JsonProperty("supplementalData")] public SupplementalData? SupplementalData { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DirectIncomeLineItem.cs b/lending/Codat/Lending/Models/Components/DirectIncomeLineItem.cs index a619c00d5..3bab86fd2 100644 --- a/lending/Codat/Lending/Models/Components/DirectIncomeLineItem.cs +++ b/lending/Codat/Lending/Models/Components/DirectIncomeLineItem.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class DirectIncomeLineItem { - /// /// A user-friendly name of the goods or services. /// @@ -25,21 +24,15 @@ public class DirectIncomeLineItem /// /// The price of each unit of goods or services.
- /// - /// /// Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. - /// ///
[JsonProperty("unitAmount")] public decimal UnitAmount { get; set; } = default!; /// /// The number of units of goods or services received.
- /// - /// ///
/// Note: If the platform does not provide this information, the quantity will be mapped as 1. - ///
///
[JsonProperty("quantity")] public decimal Quantity { get; set; } = default!; @@ -64,10 +57,7 @@ public class DirectIncomeLineItem /// /// The amount of tax for the line.
- /// - /// /// Note: If the platform does not provide this information, the quantity will be mapped as 0.00. - /// ///
[JsonProperty("taxAmount")] public decimal? TaxAmount { get; set; } = null; @@ -86,8 +76,6 @@ public class DirectIncomeLineItem /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -96,8 +84,7 @@ public class DirectIncomeLineItem /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
[JsonProperty("taxRateRef")] public TaxRateRef? TaxRateRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/DisputeStatus.cs b/lending/Codat/Lending/Models/Components/DisputeStatus.cs index 43b8ad4f4..70ba00925 100644 --- a/lending/Codat/Lending/Models/Components/DisputeStatus.cs +++ b/lending/Codat/Lending/Models/Components/DisputeStatus.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Current status of the dispute + /// Current status of the dispute. /// public enum DisputeStatus { @@ -74,5 +74,4 @@ public static DisputeStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DisputeStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/EndUploadSessionRequest.cs b/lending/Codat/Lending/Models/Components/EndUploadSessionRequest.cs index 93f74aaa0..e4284d852 100644 --- a/lending/Codat/Lending/Models/Components/EndUploadSessionRequest.cs +++ b/lending/Codat/Lending/Models/Components/EndUploadSessionRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class EndUploadSessionRequest { - /// /// An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. /// diff --git a/lending/Codat/Lending/Models/Components/EndUploadSessionRequestStatus.cs b/lending/Codat/Lending/Models/Components/EndUploadSessionRequestStatus.cs index cc0c34edc..0a98f7622 100644 --- a/lending/Codat/Lending/Models/Components/EndUploadSessionRequestStatus.cs +++ b/lending/Codat/Lending/Models/Components/EndUploadSessionRequestStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. /// @@ -56,5 +56,4 @@ public static EndUploadSessionRequestStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum EndUploadSessionRequestStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/EnhancedCashFlowItem.cs b/lending/Codat/Lending/Models/Components/EnhancedCashFlowItem.cs index df84c6b64..516aa1ccc 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedCashFlowItem.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedCashFlowItem.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class EnhancedCashFlowItem { - /// /// An array of transaction data. /// diff --git a/lending/Codat/Lending/Models/Components/EnhancedCashFlowTransactions.cs b/lending/Codat/Lending/Models/Components/EnhancedCashFlowTransactions.cs index a100a6f51..c39f6ff7c 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedCashFlowTransactions.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedCashFlowTransactions.cs @@ -13,20 +13,16 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// > **Categorization engine**
- /// - /// /// >
/// > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.
///
- /// The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. - ///
+ /// The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. ///
public class EnhancedCashFlowTransactions { - /// /// Report additional information, which is specific to Lending reports. /// diff --git a/lending/Codat/Lending/Models/Components/EnhancedFinancialReport.cs b/lending/Codat/Lending/Models/Components/EnhancedFinancialReport.cs index 5ef64f1ac..06ac17247 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedFinancialReport.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedFinancialReport.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class EnhancedFinancialReport { - [JsonProperty("reportInfo")] public EnhancedReportInfo? ReportInfo { get; set; } diff --git a/lending/Codat/Lending/Models/Components/EnhancedInvoiceReportItem.cs b/lending/Codat/Lending/Models/Components/EnhancedInvoiceReportItem.cs index 5cdd4d71c..f496e7377 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedInvoiceReportItem.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedInvoiceReportItem.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class EnhancedInvoiceReportItem { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -39,9 +38,7 @@ public class EnhancedInvoiceReportItem public LendingCustomerRef? CustomerRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -60,15 +57,12 @@ public class EnhancedInvoiceReportItem /// >
/// > 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. - ///
///
[JsonProperty("issueDate")] public string? IssueDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -87,49 +81,42 @@ public class EnhancedInvoiceReportItem /// >
/// > 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. - ///
///
[JsonProperty("dueDate")] public string? DueDate { get; set; } /// /// Current state of the invoice:
- /// - /// ///
- /// - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
+ /// - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
/// - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld).
/// - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`.
/// - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`.
- /// - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. - ///
+ /// - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. ///
[JsonProperty("status")] public InvoiceStatus? Status { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// - /// Invoice's total amount. + /// Invoice's total amount. /// [JsonProperty("totalAmount")] public decimal? TotalAmount { get; set; } /// - /// Invoice's total amount due. + /// Invoice's total amount due. /// [JsonProperty("amountDue")] public decimal? AmountDue { get; set; } @@ -138,9 +125,7 @@ public class EnhancedInvoiceReportItem public List? Payments { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -159,7 +144,6 @@ public class EnhancedInvoiceReportItem /// >
/// > 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. - ///
///
[JsonProperty("paidOnDate")] public string? PaidOnDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/EnhancedInvoicesReport.cs b/lending/Codat/Lending/Models/Components/EnhancedInvoicesReport.cs index afdb3ad3d..ae543a05b 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedInvoicesReport.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedInvoicesReport.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by matching with the bank statement. /// public class EnhancedInvoicesReport { - /// /// Report additional information, which is specific to Lending reports. /// diff --git a/lending/Codat/Lending/Models/Components/EnhancedReportAccountCategory.cs b/lending/Codat/Lending/Models/Components/EnhancedReportAccountCategory.cs index 3a56179de..fcbc3c3c8 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedReportAccountCategory.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedReportAccountCategory.cs @@ -13,12 +13,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class EnhancedReportAccountCategory { - /// - /// Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned. + /// Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned. /// [JsonProperty("status")] public string? Status { get; set; } diff --git a/lending/Codat/Lending/Models/Components/EnhancedReportInfo.cs b/lending/Codat/Lending/Models/Components/EnhancedReportInfo.cs index be23f0e5d..edccd6058 100644 --- a/lending/Codat/Lending/Models/Components/EnhancedReportInfo.cs +++ b/lending/Codat/Lending/Models/Components/EnhancedReportInfo.cs @@ -11,21 +11,17 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class EnhancedReportInfo { - /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -43,9 +39,7 @@ public class EnhancedReportInfo public string? CompanyName { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -64,7 +58,6 @@ public class EnhancedReportInfo /// >
/// > 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. - ///
///
[JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ErrorStatus.cs b/lending/Codat/Lending/Models/Components/ErrorStatus.cs index 5a32bfa67..5ef08f6b4 100644 --- a/lending/Codat/Lending/Models/Components/ErrorStatus.cs +++ b/lending/Codat/Lending/Models/Components/ErrorStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of a transient error. Null statuses indicate that the error is not transient. /// @@ -56,5 +56,4 @@ public static ErrorStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ErrorStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ErrorValidation.cs b/lending/Codat/Lending/Models/Components/ErrorValidation.cs index d0e29f20c..db67c55ce 100644 --- a/lending/Codat/Lending/Models/Components/ErrorValidation.cs +++ b/lending/Codat/Lending/Models/Components/ErrorValidation.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. /// public class ErrorValidation { - [JsonProperty("errors")] public List? Errors { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/ErrorValidationItem.cs b/lending/Codat/Lending/Models/Components/ErrorValidationItem.cs index 9e8758327..204208cae 100644 --- a/lending/Codat/Lending/Models/Components/ErrorValidationItem.cs +++ b/lending/Codat/Lending/Models/Components/ErrorValidationItem.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ErrorValidationItem { - /// /// Unique identifier for a validation item. /// @@ -22,7 +21,7 @@ public class ErrorValidationItem public string? ItemId { get; set; } = null; /// - /// A message outlining validation item's issue. + /// A message outlining validation item's issue. /// [JsonProperty("message")] public string? Message { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/ExcelReportTypes.cs b/lending/Codat/Lending/Models/Components/ExcelReportTypes.cs index 6264dde68..802e0abe2 100644 --- a/lending/Codat/Lending/Models/Components/ExcelReportTypes.cs +++ b/lending/Codat/Lending/Models/Components/ExcelReportTypes.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of the report requested in the query string. /// @@ -60,5 +60,4 @@ public static ExcelReportTypes ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ExcelReportTypes"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ExcelStatus.cs b/lending/Codat/Lending/Models/Components/ExcelStatus.cs index 3e230bccf..a94a79502 100644 --- a/lending/Codat/Lending/Models/Components/ExcelStatus.cs +++ b/lending/Codat/Lending/Models/Components/ExcelStatus.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ExcelStatus { - /// - /// 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:
- /// - /// + /// 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
@@ -38,7 +35,6 @@ public class ExcelStatus /// >
/// > 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. - ///
///
[JsonProperty("lastGenerated")] public string? LastGenerated { get; set; } diff --git a/lending/Codat/Lending/Models/Components/File.cs b/lending/Codat/Lending/Models/Components/File.cs index a81b3ddb2..f063e4fce 100644 --- a/lending/Codat/Lending/Models/Components/File.cs +++ b/lending/Codat/Lending/Models/Components/File.cs @@ -11,12 +11,11 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class File { - /// - /// The file's name. + /// The file's name. /// [JsonProperty("fileName")] public string? FileName { get; set; } = null; @@ -34,9 +33,7 @@ public class File public string? SourceType { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -55,7 +52,6 @@ public class File /// >
/// > 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. - ///
///
[JsonProperty("uploaded")] public string? Uploaded { get; set; } diff --git a/lending/Codat/Lending/Models/Components/FileUpload.cs b/lending/Codat/Lending/Models/Components/FileUpload.cs index f23f3c68f..018ca1493 100644 --- a/lending/Codat/Lending/Models/Components/FileUpload.cs +++ b/lending/Codat/Lending/Models/Components/FileUpload.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class FileUpload { - /// /// The file to be uploaded as an attachment. /// diff --git a/lending/Codat/Lending/Models/Components/HalRef.cs b/lending/Codat/Lending/Models/Components/HalRef.cs index 29b73d3e4..e06ead838 100644 --- a/lending/Codat/Lending/Models/Components/HalRef.cs +++ b/lending/Codat/Lending/Models/Components/HalRef.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class HalRef { - /// /// Uri hypertext reference. /// diff --git a/lending/Codat/Lending/Models/Components/IntegrityStatus.cs b/lending/Codat/Lending/Models/Components/IntegrityStatus.cs index 92cd5fd7f..b107568cb 100644 --- a/lending/Codat/Lending/Models/Components/IntegrityStatus.cs +++ b/lending/Codat/Lending/Models/Components/IntegrityStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the most recently run matching algorithm. /// @@ -60,5 +60,4 @@ public static IntegrityStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum IntegrityStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/InvoiceLineItem.cs b/lending/Codat/Lending/Models/Components/InvoiceLineItem.cs index 8dbc42289..efd56530b 100644 --- a/lending/Codat/Lending/Models/Components/InvoiceLineItem.cs +++ b/lending/Codat/Lending/Models/Components/InvoiceLineItem.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class InvoiceLineItem { - /// /// Friendly name of the goods or services provided. /// @@ -73,8 +72,6 @@ public class InvoiceLineItem /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -83,8 +80,7 @@ public class InvoiceLineItem /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
[JsonProperty("taxRateRef")] public TaxRateRef? TaxRateRef { get; set; } diff --git a/lending/Codat/Lending/Models/Components/InvoiceStatus.cs b/lending/Codat/Lending/Models/Components/InvoiceStatus.cs index c938f2850..ae349dbcf 100644 --- a/lending/Codat/Lending/Models/Components/InvoiceStatus.cs +++ b/lending/Codat/Lending/Models/Components/InvoiceStatus.cs @@ -12,18 +12,15 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Current state of the invoice:
- /// - /// ///
- /// - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
+ /// - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
/// - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld).
/// - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`.
/// - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`.
- /// - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. - ///
+ /// - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. ///
public enum InvoiceStatus { @@ -73,5 +70,4 @@ public static InvoiceStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum InvoiceStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ItemRef.cs b/lending/Codat/Lending/Models/Components/ItemRef.cs index bd52ef191..a79c6d237 100644 --- a/lending/Codat/Lending/Models/Components/ItemRef.cs +++ b/lending/Codat/Lending/Models/Components/ItemRef.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ItemRef { - /// /// The id of the object, e.g. the Journal entry. /// diff --git a/lending/Codat/Lending/Models/Components/ItemReference.cs b/lending/Codat/Lending/Models/Components/ItemReference.cs index 05af3cf07..86778989c 100644 --- a/lending/Codat/Lending/Models/Components/ItemReference.cs +++ b/lending/Codat/Lending/Models/Components/ItemReference.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference to the item the line is linked to. /// public class ItemReference { - /// /// Unique identifier for the item in the accounting software. /// diff --git a/lending/Codat/Lending/Models/Components/Items.cs b/lending/Codat/Lending/Models/Components/Items.cs index d428010c3..3f515e241 100644 --- a/lending/Codat/Lending/Models/Components/Items.cs +++ b/lending/Codat/Lending/Models/Components/Items.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class Items { - /// /// Name assigned to withheld tax. /// diff --git a/lending/Codat/Lending/Models/Components/JournalEntryRecordRef.cs b/lending/Codat/Lending/Models/Components/JournalEntryRecordRef.cs index 84468a2de..61f60da4c 100644 --- a/lending/Codat/Lending/Models/Components/JournalEntryRecordRef.cs +++ b/lending/Codat/Lending/Models/Components/JournalEntryRecordRef.cs @@ -12,15 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links a journal entry to the underlying record that created it. /// public class JournalEntryRecordRef { - /// - /// 'id' of the underlying record or data type. + /// 'id' of the underlying record or data type. /// [JsonProperty("id")] public string? Id { get; set; } diff --git a/lending/Codat/Lending/Models/Components/JournalEntryRecordRefDataType.cs b/lending/Codat/Lending/Models/Components/JournalEntryRecordRefDataType.cs index 75f42b190..07ef10ba6 100644 --- a/lending/Codat/Lending/Models/Components/JournalEntryRecordRefDataType.cs +++ b/lending/Codat/Lending/Models/Components/JournalEntryRecordRefDataType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Name of underlying data type. /// @@ -74,5 +74,4 @@ public static JournalEntryRecordRefDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum JournalEntryRecordRefDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/JournalLine.cs b/lending/Codat/Lending/Models/Components/JournalLine.cs index c69f9b083..b91480b81 100644 --- a/lending/Codat/Lending/Models/Components/JournalLine.cs +++ b/lending/Codat/Lending/Models/Components/JournalLine.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class JournalLine { - /// /// Description of the journal line item. /// @@ -53,7 +52,7 @@ public class JournalLine public AccountRef? AccountRef { get; set; } /// - /// List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.) + /// List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.). /// [JsonProperty("tracking")] public JournalLineTracking? Tracking { get; set; } diff --git a/lending/Codat/Lending/Models/Components/JournalLineDataType.cs b/lending/Codat/Lending/Models/Components/JournalLineDataType.cs index d9bbfd1cf..7f00cfe73 100644 --- a/lending/Codat/Lending/Models/Components/JournalLineDataType.cs +++ b/lending/Codat/Lending/Models/Components/JournalLineDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// public enum JournalLineDataType { @@ -56,5 +56,4 @@ public static JournalLineDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum JournalLineDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/JournalLineTracking.cs b/lending/Codat/Lending/Models/Components/JournalLineTracking.cs index aad342287..22472ccac 100644 --- a/lending/Codat/Lending/Models/Components/JournalLineTracking.cs +++ b/lending/Codat/Lending/Models/Components/JournalLineTracking.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.) + /// List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.). /// public class JournalLineTracking { - [JsonProperty("recordRefs")] public List? RecordRefs { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Components/JournalRef.cs b/lending/Codat/Lending/Models/Components/JournalRef.cs index 217736907..86fd1345a 100644 --- a/lending/Codat/Lending/Models/Components/JournalRef.cs +++ b/lending/Codat/Lending/Models/Components/JournalRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). /// public class JournalRef { - /// /// GUID of the underlying journal. /// @@ -25,7 +24,7 @@ public class JournalRef public string Id { get; set; } = default!; /// - /// Name of journal + /// Name of journal. /// [JsonProperty("name")] public string? Name { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/JournalStatus.cs b/lending/Codat/Lending/Models/Components/JournalStatus.cs index 147c2b779..ab001d8e4 100644 --- a/lending/Codat/Lending/Models/Components/JournalStatus.cs +++ b/lending/Codat/Lending/Models/Components/JournalStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Current journal status. /// @@ -58,5 +58,4 @@ public static JournalStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum JournalStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/LendingCustomerRef.cs b/lending/Codat/Lending/Models/Components/LendingCustomerRef.cs index a6ff3fc02..019c53ce8 100644 --- a/lending/Codat/Lending/Models/Components/LendingCustomerRef.cs +++ b/lending/Codat/Lending/Models/Components/LendingCustomerRef.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class LendingCustomerRef { - /// /// `id` from the Customers data type. /// diff --git a/lending/Codat/Lending/Models/Components/Links.cs b/lending/Codat/Lending/Models/Components/Links.cs index ef249ad8d..2c28a1a10 100644 --- a/lending/Codat/Lending/Models/Components/Links.cs +++ b/lending/Codat/Lending/Models/Components/Links.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class Links { - [JsonProperty("self")] public HalRef Self { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/LoanRef.cs b/lending/Codat/Lending/Models/Components/LoanRef.cs index c1eef36a5..46e2f4a02 100644 --- a/lending/Codat/Lending/Models/Components/LoanRef.cs +++ b/lending/Codat/Lending/Models/Components/LoanRef.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class LoanRef { - /// /// The id of the object being referred to. /// diff --git a/lending/Codat/Lending/Models/Components/LoanSummary.cs b/lending/Codat/Lending/Models/Components/LoanSummary.cs index 05672931e..3ac9162c7 100644 --- a/lending/Codat/Lending/Models/Components/LoanSummary.cs +++ b/lending/Codat/Lending/Models/Components/LoanSummary.cs @@ -13,15 +13,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class LoanSummary { - [JsonProperty("reportInfo")] public LoanSummaryReportInfo? ReportInfo { get; set; } /// - /// Returns a summary of all loan activity for that integration type + /// Returns a summary of all loan activity for that integration type. /// [JsonProperty("reportItems")] public List? ReportItems { get; set; } diff --git a/lending/Codat/Lending/Models/Components/LoanSummaryIntegrationType.cs b/lending/Codat/Lending/Models/Components/LoanSummaryIntegrationType.cs index f86573f0a..740d42a1e 100644 --- a/lending/Codat/Lending/Models/Components/LoanSummaryIntegrationType.cs +++ b/lending/Codat/Lending/Models/Components/LoanSummaryIntegrationType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The integration type begin referred to. /// @@ -58,5 +58,4 @@ public static LoanSummaryIntegrationType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum LoanSummaryIntegrationType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/LoanSummaryRecordRef.cs b/lending/Codat/Lending/Models/Components/LoanSummaryRecordRef.cs index c59ad936f..1e3869678 100644 --- a/lending/Codat/Lending/Models/Components/LoanSummaryRecordRef.cs +++ b/lending/Codat/Lending/Models/Components/LoanSummaryRecordRef.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class LoanSummaryRecordRef { - /// /// The id of the object being referred to. /// diff --git a/lending/Codat/Lending/Models/Components/LoanSummaryRecordRefType.cs b/lending/Codat/Lending/Models/Components/LoanSummaryRecordRefType.cs index 79e1c225a..235bf0369 100644 --- a/lending/Codat/Lending/Models/Components/LoanSummaryRecordRefType.cs +++ b/lending/Codat/Lending/Models/Components/LoanSummaryRecordRefType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The datatype being referred to. /// @@ -58,5 +58,4 @@ public static LoanSummaryRecordRefType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum LoanSummaryRecordRefType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/LoanSummaryReportInfo.cs b/lending/Codat/Lending/Models/Components/LoanSummaryReportInfo.cs index b5a0e8f5d..dbc21c3cb 100644 --- a/lending/Codat/Lending/Models/Components/LoanSummaryReportInfo.cs +++ b/lending/Codat/Lending/Models/Components/LoanSummaryReportInfo.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class LoanSummaryReportInfo { - /// /// The name of the report. /// @@ -28,9 +27,7 @@ public class LoanSummaryReportInfo public string? CompanyName { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -49,7 +46,6 @@ public class LoanSummaryReportInfo /// >
/// > 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. - ///
///
[JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/LoanSummaryReportItem.cs b/lending/Codat/Lending/Models/Components/LoanSummaryReportItem.cs index 9dde26162..6fab4a85f 100644 --- a/lending/Codat/Lending/Models/Components/LoanSummaryReportItem.cs +++ b/lending/Codat/Lending/Models/Components/LoanSummaryReportItem.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class LoanSummaryReportItem { - [JsonProperty("recordRef")] public LoanSummaryRecordRef? RecordRef { get; set; } @@ -26,9 +25,7 @@ public class LoanSummaryReportItem public string? Description { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -47,7 +44,6 @@ public class LoanSummaryReportItem /// >
/// > 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. - ///
///
[JsonProperty("startDate")] public string? StartDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/LoanTransactionType.cs b/lending/Codat/Lending/Models/Components/LoanTransactionType.cs index 29389e25e..f5a798542 100644 --- a/lending/Codat/Lending/Models/Components/LoanTransactionType.cs +++ b/lending/Codat/Lending/Models/Components/LoanTransactionType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of loan transaction. /// @@ -60,5 +60,4 @@ public static LoanTransactionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum LoanTransactionType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/LoanTransactions.cs b/lending/Codat/Lending/Models/Components/LoanTransactions.cs index ad4e2d8e6..97c6ee703 100644 --- a/lending/Codat/Lending/Models/Components/LoanTransactions.cs +++ b/lending/Codat/Lending/Models/Components/LoanTransactions.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class LoanTransactions { - [JsonProperty("reportInfo")] public LoanTransactionsReportInfo? ReportInfo { get; set; } diff --git a/lending/Codat/Lending/Models/Components/LoanTransactionsReportInfo.cs b/lending/Codat/Lending/Models/Components/LoanTransactionsReportInfo.cs index bf8b886ce..61c660a42 100644 --- a/lending/Codat/Lending/Models/Components/LoanTransactionsReportInfo.cs +++ b/lending/Codat/Lending/Models/Components/LoanTransactionsReportInfo.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class LoanTransactionsReportInfo { - /// /// The page number. /// @@ -46,9 +45,7 @@ public class LoanTransactionsReportInfo public string? CompanyName { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -67,7 +64,6 @@ public class LoanTransactionsReportInfo /// >
/// > 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. - ///
///
[JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/LocationRef.cs b/lending/Codat/Lending/Models/Components/LocationRef.cs index aab38b78f..b8f7a8bed 100644 --- a/lending/Codat/Lending/Models/Components/LocationRef.cs +++ b/lending/Codat/Lending/Models/Components/LocationRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference to the geographic location where the order was placed. /// public class LocationRef { - /// /// The unique identitifer of the location being referenced. /// diff --git a/lending/Codat/Lending/Models/Components/Metadata.cs b/lending/Codat/Lending/Models/Components/Metadata.cs index 17bd28e0d..ef4232f18 100644 --- a/lending/Codat/Lending/Models/Components/Metadata.cs +++ b/lending/Codat/Lending/Models/Components/Metadata.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class Metadata { - /// /// Indicates whether the record has been deleted in the third-party system this record originated from. /// diff --git a/lending/Codat/Lending/Models/Components/OrderDiscountAllocation.cs b/lending/Codat/Lending/Models/Components/OrderDiscountAllocation.cs index 38ec2787e..67a0aa93b 100644 --- a/lending/Codat/Lending/Models/Components/OrderDiscountAllocation.cs +++ b/lending/Codat/Lending/Models/Components/OrderDiscountAllocation.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class OrderDiscountAllocation { - /// /// Name of the discount in the commerce or point of sale platform. /// diff --git a/lending/Codat/Lending/Models/Components/OrderLineItem.cs b/lending/Codat/Lending/Models/Components/OrderLineItem.cs index 53024f1b2..4a79acc85 100644 --- a/lending/Codat/Lending/Models/Components/OrderLineItem.cs +++ b/lending/Codat/Lending/Models/Components/OrderLineItem.cs @@ -13,23 +13,18 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class OrderLineItem { - /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// /// Number of units of the product sold.
- /// - /// - /// For refunds, quantity is negative.
- /// - ///
+ /// For refunds, quantity is negative. ///
[JsonProperty("quantity")] public decimal? Quantity { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Path.cs b/lending/Codat/Lending/Models/Components/Path.cs index dbc601c59..c9a17a02d 100644 --- a/lending/Codat/Lending/Models/Components/Path.cs +++ b/lending/Codat/Lending/Models/Components/Path.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + public enum Path { [JsonProperty("auth/get")] @@ -51,5 +51,4 @@ public static Path ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Path"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/Payment.cs b/lending/Codat/Lending/Models/Components/Payment.cs index 653133b9f..326f93a4f 100644 --- a/lending/Codat/Lending/Models/Components/Payment.cs +++ b/lending/Codat/Lending/Models/Components/Payment.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Payment { - /// /// ID of the invoice, which may be a GUID but it may be something else depending on the accounting software. /// @@ -24,9 +23,7 @@ public class Payment public string? Id { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -45,7 +42,6 @@ public class Payment /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } @@ -64,27 +60,22 @@ public class Payment /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -112,7 +103,6 @@ public class Payment /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/PaymentAllocationPayment.cs b/lending/Codat/Lending/Models/Components/PaymentAllocationPayment.cs index b696bc412..8e4d5aa41 100644 --- a/lending/Codat/Lending/Models/Components/PaymentAllocationPayment.cs +++ b/lending/Codat/Lending/Models/Components/PaymentAllocationPayment.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PaymentAllocationPayment { - /// /// Identifier of the allocated payment. /// @@ -42,27 +41,22 @@ public class PaymentAllocationPayment /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// /// 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.
+ /// 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).
///
@@ -90,15 +84,12 @@ public class PaymentAllocationPayment /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -117,7 +108,6 @@ public class PaymentAllocationPayment /// >
/// > 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. - ///
///
[JsonProperty("paidOnDate")] public string? PaidOnDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PaymentLine.cs b/lending/Codat/Lending/Models/Components/PaymentLine.cs index f91316172..1934deb84 100644 --- a/lending/Codat/Lending/Models/Components/PaymentLine.cs +++ b/lending/Codat/Lending/Models/Components/PaymentLine.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PaymentLine { - /// /// Amount in the payment currency. /// @@ -27,9 +26,7 @@ public class PaymentLine public List? Links { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -48,7 +45,6 @@ public class PaymentLine /// >
/// > 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. - ///
///
[JsonProperty("allocatedOnDate")] public string? AllocatedOnDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PaymentLineLink.cs b/lending/Codat/Lending/Models/Components/PaymentLineLink.cs index e6e8863ec..be6113fcc 100644 --- a/lending/Codat/Lending/Models/Components/PaymentLineLink.cs +++ b/lending/Codat/Lending/Models/Components/PaymentLineLink.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PaymentLineLink { - /// /// Types of payment line links, either:
- /// - /// /// `Unknown`
/// `Unlinked` - Not used
/// `Invoice` - ID refers to the invoice
@@ -29,8 +26,7 @@ public class PaymentLineLink /// `PaymentOnAccount` - ID refers to the customer
/// `Other` - ID refers to the customer
/// `Manual Journal`
- /// `Discount` - ID refers to the payment - ///
+ /// `Discount` - ID refers to the payment. ///
[JsonProperty("type")] public PaymentLinkType Type { get; set; } = default!; @@ -43,23 +39,18 @@ public class PaymentLineLink /// /// Amount by which the balance of the linked entity is altered, in the currency of the linked entity.
- /// - /// /// A negative link amount _reduces_ the outstanding amount on the accounts receivable account.
/// A positive link amount _increases_ the outstanding amount on the accounts receivable account. - ///
///
[JsonProperty("amount")] public decimal? Amount { get; set; } = null; /// /// 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.
+ /// 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).
///
@@ -87,7 +78,6 @@ public class PaymentLineLink /// | 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. | - ///
///
[JsonProperty("currencyRate")] public decimal? CurrencyRate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/PaymentLinkType.cs b/lending/Codat/Lending/Models/Components/PaymentLinkType.cs index 7bc64119f..eb23d4403 100644 --- a/lending/Codat/Lending/Models/Components/PaymentLinkType.cs +++ b/lending/Codat/Lending/Models/Components/PaymentLinkType.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Types of payment line links, either:
- /// - /// /// `Unknown`
/// `Unlinked` - Not used
/// `Invoice` - ID refers to the invoice
@@ -26,8 +24,7 @@ namespace Codat.Lending.Models.Components /// `PaymentOnAccount` - ID refers to the customer
/// `Other` - ID refers to the customer
/// `Manual Journal`
- /// `Discount` - ID refers to the payment - ///
+ /// `Discount` - ID refers to the payment. ///
public enum PaymentLinkType { @@ -85,5 +82,4 @@ public static PaymentLinkType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PaymentLinkType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PaymentMethodRef.cs b/lending/Codat/Lending/Models/Components/PaymentMethodRef.cs index 94ae5fd23..5d16225ef 100644 --- a/lending/Codat/Lending/Models/Components/PaymentMethodRef.cs +++ b/lending/Codat/Lending/Models/Components/PaymentMethodRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The Payment Method to which the payment is linked in the accounting software. /// public class PaymentMethodRef { - /// /// The unique identifier of the location being referenced. /// diff --git a/lending/Codat/Lending/Models/Components/PaymentRef.cs b/lending/Codat/Lending/Models/Components/PaymentRef.cs index 189aa746a..f136cb300 100644 --- a/lending/Codat/Lending/Models/Components/PaymentRef.cs +++ b/lending/Codat/Lending/Models/Components/PaymentRef.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PaymentRef { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -23,7 +22,7 @@ public class PaymentRef public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; @@ -36,15 +35,12 @@ public class PaymentRef /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -68,9 +64,7 @@ public class PaymentRef public string? PaymentProvider { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -89,15 +83,12 @@ public class PaymentRef /// >
/// > 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. - ///
///
[JsonProperty("dueDate")] public string? DueDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -116,7 +107,6 @@ public class PaymentRef /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PaymentStatus.cs b/lending/Codat/Lending/Models/Components/PaymentStatus.cs index 0e17b5a61..bee70fbeb 100644 --- a/lending/Codat/Lending/Models/Components/PaymentStatus.cs +++ b/lending/Codat/Lending/Models/Components/PaymentStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the payment. /// @@ -64,5 +64,4 @@ public static PaymentStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PaymentStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PaymentType.cs b/lending/Codat/Lending/Models/Components/PaymentType.cs index d85e79e76..e592454bc 100644 --- a/lending/Codat/Lending/Models/Components/PaymentType.cs +++ b/lending/Codat/Lending/Models/Components/PaymentType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Type of payment. /// @@ -76,5 +76,4 @@ public static PaymentType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PaymentType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PeriodUnit.cs b/lending/Codat/Lending/Models/Components/PeriodUnit.cs index 20e662ab0..fb846cf73 100644 --- a/lending/Codat/Lending/Models/Components/PeriodUnit.cs +++ b/lending/Codat/Lending/Models/Components/PeriodUnit.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + public enum PeriodUnit { [JsonProperty("Day")] @@ -57,5 +57,4 @@ public static PeriodUnit ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PeriodUnit"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PhoneNumber.cs b/lending/Codat/Lending/Models/Components/PhoneNumber.cs index c82f8b991..8dc6001ab 100644 --- a/lending/Codat/Lending/Models/Components/PhoneNumber.cs +++ b/lending/Codat/Lending/Models/Components/PhoneNumber.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PhoneNumber { - /// /// A phone number. /// @@ -23,7 +22,7 @@ public class PhoneNumber public string? Number { get; set; } = null; /// - /// The type of phone number + /// The type of phone number. /// [JsonProperty("type")] public Models.Components.Type Type { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/ProductInventory.cs b/lending/Codat/Lending/Models/Components/ProductInventory.cs index a800f006b..551180860 100644 --- a/lending/Codat/Lending/Models/Components/ProductInventory.cs +++ b/lending/Codat/Lending/Models/Components/ProductInventory.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// Information about the total inventory as well as the locations inventory is in. /// public class ProductInventory { - /// /// The total quantity of stock remaining across locations. /// diff --git a/lending/Codat/Lending/Models/Components/ProductInventoryLocation.cs b/lending/Codat/Lending/Models/Components/ProductInventoryLocation.cs index 0ffa51976..fc45e589b 100644 --- a/lending/Codat/Lending/Models/Components/ProductInventoryLocation.cs +++ b/lending/Codat/Lending/Models/Components/ProductInventoryLocation.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ProductInventoryLocation { - /// /// The quantity of stock remaining at location. /// diff --git a/lending/Codat/Lending/Models/Components/ProductPrice.cs b/lending/Codat/Lending/Models/Components/ProductPrice.cs index 8a860b93b..c51ae1604 100644 --- a/lending/Codat/Lending/Models/Components/ProductPrice.cs +++ b/lending/Codat/Lending/Models/Components/ProductPrice.cs @@ -11,27 +11,23 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ProductPrice { - /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } /// - /// The product variant's unit price. + /// The product variant's unit price. /// [JsonProperty("unitPrice")] public decimal? UnitPrice { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ProductRef.cs b/lending/Codat/Lending/Models/Components/ProductRef.cs index 40813eed2..8504f3bb2 100644 --- a/lending/Codat/Lending/Models/Components/ProductRef.cs +++ b/lending/Codat/Lending/Models/Components/ProductRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference that links the line item to the correct product details. /// public class ProductRef { - /// /// The unique identifier of the product being referenced. /// diff --git a/lending/Codat/Lending/Models/Components/ProductVariant.cs b/lending/Codat/Lending/Models/Components/ProductVariant.cs index 52086cb03..8b8255580 100644 --- a/lending/Codat/Lending/Models/Components/ProductVariant.cs +++ b/lending/Codat/Lending/Models/Components/ProductVariant.cs @@ -13,17 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors.
- /// - /// - /// - /// + /// Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors. ///
public class ProductVariant { - [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -31,7 +26,7 @@ public class ProductVariant public string? SourceModifiedDate { get; set; } /// - /// A unique, persistent identifier for this record + /// A unique, persistent identifier for this record. /// [JsonProperty("id")] public string Id { get; set; } = default!; @@ -97,9 +92,7 @@ public class ProductVariant public ProductVariantStatus? Status { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -118,7 +111,6 @@ public class ProductVariant /// >
/// > 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. - ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ProductVariantRef.cs b/lending/Codat/Lending/Models/Components/ProductVariantRef.cs index bf9abbc6d..0b2f2b7ef 100644 --- a/lending/Codat/Lending/Models/Components/ProductVariantRef.cs +++ b/lending/Codat/Lending/Models/Components/ProductVariantRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference that links the line item to the specific version of product that has been ordered. /// public class ProductVariantRef { - /// /// The unique identifier of the product variant being referenced. /// diff --git a/lending/Codat/Lending/Models/Components/ProductVariantStatus.cs b/lending/Codat/Lending/Models/Components/ProductVariantStatus.cs index 756c393c1..2080cdd43 100644 --- a/lending/Codat/Lending/Models/Components/ProductVariantStatus.cs +++ b/lending/Codat/Lending/Models/Components/ProductVariantStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The status of the product variant. /// @@ -58,5 +58,4 @@ public static ProductVariantStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ProductVariantStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ProfitAndLossReport.cs b/lending/Codat/Lending/Models/Components/ProfitAndLossReport.cs index 6b8e3966e..61eaaa999 100644 --- a/lending/Codat/Lending/Models/Components/ProfitAndLossReport.cs +++ b/lending/Codat/Lending/Models/Components/ProfitAndLossReport.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ProfitAndLossReport { - /// - /// 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:
- /// - /// + /// 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
@@ -38,15 +35,12 @@ public class ProfitAndLossReport /// >
/// > 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. - ///
///
[JsonProperty("fromDate")] public string? FromDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -65,7 +59,6 @@ public class ProfitAndLossReport /// >
/// > 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. - ///
///
[JsonProperty("toDate")] public string? ToDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ProjectRef.cs b/lending/Codat/Lending/Models/Components/ProjectRef.cs index d05023fc4..c4b672867 100644 --- a/lending/Codat/Lending/Models/Components/ProjectRef.cs +++ b/lending/Codat/Lending/Models/Components/ProjectRef.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ProjectRef { - /// /// Unique identifier to the project reference. /// @@ -22,7 +21,7 @@ public class ProjectRef public string Id { get; set; } = default!; /// - /// The project's name. + /// The project's name. /// [JsonProperty("name")] public string? Name { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/PropertieAccountType.cs b/lending/Codat/Lending/Models/Components/PropertieAccountType.cs index 4b7d8dc76..bf54e6159 100644 --- a/lending/Codat/Lending/Models/Components/PropertieAccountType.cs +++ b/lending/Codat/Lending/Models/Components/PropertieAccountType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard. /// @@ -62,5 +62,4 @@ public static PropertieAccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PropertieAccountType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PropertieDataType.cs b/lending/Codat/Lending/Models/Components/PropertieDataType.cs index c5cbce1a6..c38da6f72 100644 --- a/lending/Codat/Lending/Models/Components/PropertieDataType.cs +++ b/lending/Codat/Lending/Models/Components/PropertieDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Available data types + /// Available data types. /// public enum PropertieDataType { @@ -138,5 +138,4 @@ public static PropertieDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PropertieDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PropertieItemRef.cs b/lending/Codat/Lending/Models/Components/PropertieItemRef.cs index 62e923578..1c7d9a302 100644 --- a/lending/Codat/Lending/Models/Components/PropertieItemRef.cs +++ b/lending/Codat/Lending/Models/Components/PropertieItemRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference to the item the line is linked to. /// public class PropertieItemRef { - /// /// Unique identifier for the item in the accounting software. /// diff --git a/lending/Codat/Lending/Models/Components/PullOperation.cs b/lending/Codat/Lending/Models/Components/PullOperation.cs index cf302c7de..6d44ca878 100644 --- a/lending/Codat/Lending/Models/Components/PullOperation.cs +++ b/lending/Codat/Lending/Models/Components/PullOperation.cs @@ -12,17 +12,13 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Information about a queued, in progress or completed pull operation.
- /// - /// /// *Formally called `dataset`* - /// ///
public class PullOperation { - /// /// Unique identifier of the pull operation. /// @@ -66,9 +62,7 @@ public class PullOperation public string? ErrorMessage { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -87,15 +81,12 @@ public class PullOperation /// >
/// > 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. - ///
///
[JsonProperty("requested")] public string Requested { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -114,7 +105,6 @@ public class PullOperation /// >
/// > 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. - ///
///
[JsonProperty("completed")] public string? Completed { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PullOperations.cs b/lending/Codat/Lending/Models/Components/PullOperations.cs index 1ff01b8ea..a108ed626 100644 --- a/lending/Codat/Lending/Models/Components/PullOperations.cs +++ b/lending/Codat/Lending/Models/Components/PullOperations.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PullOperations { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PurchaseOrderReference.cs b/lending/Codat/Lending/Models/Components/PurchaseOrderReference.cs index 0c30cc811..50c045a60 100644 --- a/lending/Codat/Lending/Models/Components/PurchaseOrderReference.cs +++ b/lending/Codat/Lending/Models/Components/PurchaseOrderReference.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PurchaseOrderReference { - /// /// Identifier for the purchase order, unique for the company in the accounting software. /// diff --git a/lending/Codat/Lending/Models/Components/PushChangeType.cs b/lending/Codat/Lending/Models/Components/PushChangeType.cs index dbb3cad3d..1decab6e4 100644 --- a/lending/Codat/Lending/Models/Components/PushChangeType.cs +++ b/lending/Codat/Lending/Models/Components/PushChangeType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Type of change being applied to record in third party platform. /// @@ -62,5 +62,4 @@ public static PushChangeType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushChangeType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PushFieldValidation.cs b/lending/Codat/Lending/Models/Components/PushFieldValidation.cs index e931eb293..52beff18d 100644 --- a/lending/Codat/Lending/Models/Components/PushFieldValidation.cs +++ b/lending/Codat/Lending/Models/Components/PushFieldValidation.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PushFieldValidation { - /// /// Field name that resulted in the validation issue. /// diff --git a/lending/Codat/Lending/Models/Components/PushOperation.cs b/lending/Codat/Lending/Models/Components/PushOperation.cs index 79a45cacc..4412d1574 100644 --- a/lending/Codat/Lending/Models/Components/PushOperation.cs +++ b/lending/Codat/Lending/Models/Components/PushOperation.cs @@ -14,18 +14,17 @@ namespace Codat.Lending.Models.Components using Newtonsoft.Json; using System; using System.Collections.Generic; - + public class PushOperation { - /// - /// Contains a single entry that communicates which record has changed and the manner in which it changed. + /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } = null; /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } @@ -43,15 +42,13 @@ public class PushOperation public string PushOperationKey { get; set; } = default!; /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company's data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -70,15 +67,12 @@ public class PushOperation /// >
/// > 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. - ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -97,7 +91,6 @@ public class PushOperation /// >
/// > 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. - ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PushOperationChange.cs b/lending/Codat/Lending/Models/Components/PushOperationChange.cs index 1eaf04b02..19f496b99 100644 --- a/lending/Codat/Lending/Models/Components/PushOperationChange.cs +++ b/lending/Codat/Lending/Models/Components/PushOperationChange.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PushOperationChange { - /// /// Type of change being applied to record in third party platform. /// diff --git a/lending/Codat/Lending/Models/Components/PushOperationRef.cs b/lending/Codat/Lending/Models/Components/PushOperationRef.cs index 34f03a093..2883fe903 100644 --- a/lending/Codat/Lending/Models/Components/PushOperationRef.cs +++ b/lending/Codat/Lending/Models/Components/PushOperationRef.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PushOperationRef { - /// /// Unique identifier for a push operation. /// @@ -23,7 +22,7 @@ public class PushOperationRef public string? Id { get; set; } /// - /// Available data types + /// Available data types. /// [JsonProperty("dataType")] public PropertieDataType? DataType { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PushOperationStatus.cs b/lending/Codat/Lending/Models/Components/PushOperationStatus.cs index 3664bbcf3..0abd70bd3 100644 --- a/lending/Codat/Lending/Models/Components/PushOperationStatus.cs +++ b/lending/Codat/Lending/Models/Components/PushOperationStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the push operation. /// @@ -60,5 +60,4 @@ public static PushOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOperationStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PushOperations.cs b/lending/Codat/Lending/Models/Components/PushOperations.cs index 415e75902..5e77a12d0 100644 --- a/lending/Codat/Lending/Models/Components/PushOperations.cs +++ b/lending/Codat/Lending/Models/Components/PushOperations.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushOperations { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PushOption.cs b/lending/Codat/Lending/Models/Components/PushOption.cs index 7628c14a5..cddf77e73 100644 --- a/lending/Codat/Lending/Models/Components/PushOption.cs +++ b/lending/Codat/Lending/Models/Components/PushOption.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushOption { - /// /// The option type. /// @@ -24,7 +23,7 @@ public class PushOption public PushOptionType Type { get; set; } = default!; /// - /// The property's display name. + /// The property's display name. /// [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/PushOptionChoice.cs b/lending/Codat/Lending/Models/Components/PushOptionChoice.cs index 6cfc69263..3035bca19 100644 --- a/lending/Codat/Lending/Models/Components/PushOptionChoice.cs +++ b/lending/Codat/Lending/Models/Components/PushOptionChoice.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class PushOptionChoice { - /// /// Allowed value for field. /// @@ -29,7 +28,7 @@ public class PushOptionChoice public PushOptionType? Type { get; set; } /// - /// The property's display name. + /// The property's display name. /// [JsonProperty("displayName")] public string? DisplayName { get; set; } diff --git a/lending/Codat/Lending/Models/Components/PushOptionProperty.cs b/lending/Codat/Lending/Models/Components/PushOptionProperty.cs index 81f2e3d45..e079cf989 100644 --- a/lending/Codat/Lending/Models/Components/PushOptionProperty.cs +++ b/lending/Codat/Lending/Models/Components/PushOptionProperty.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushOptionProperty { - /// /// The option type. /// @@ -24,7 +23,7 @@ public class PushOptionProperty public PushOptionType Type { get; set; } = default!; /// - /// The property's display name. + /// The property's display name. /// [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/PushOptionType.cs b/lending/Codat/Lending/Models/Components/PushOptionType.cs index 747965c59..d8a17c79e 100644 --- a/lending/Codat/Lending/Models/Components/PushOptionType.cs +++ b/lending/Codat/Lending/Models/Components/PushOptionType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The option type. /// @@ -68,5 +68,4 @@ public static PushOptionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOptionType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/PushValidationInfo.cs b/lending/Codat/Lending/Models/Components/PushValidationInfo.cs index 9f287011f..1dd657bb7 100644 --- a/lending/Codat/Lending/Models/Components/PushValidationInfo.cs +++ b/lending/Codat/Lending/Models/Components/PushValidationInfo.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class PushValidationInfo { - [JsonProperty("warnings")] public List? Warnings { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/RecordLineReference.cs b/lending/Codat/Lending/Models/Components/RecordLineReference.cs index b982c39c6..739268cea 100644 --- a/lending/Codat/Lending/Models/Components/RecordLineReference.cs +++ b/lending/Codat/Lending/Models/Components/RecordLineReference.cs @@ -12,21 +12,20 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference to the purchase order line this line was generated from. /// public class RecordLineReference { - /// - /// 'id' of the underlying record. + /// 'id' of the underlying record. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// [JsonProperty("dataType")] public BillLineItemDataType? DataType { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ReportBasis.cs b/lending/Codat/Lending/Models/Components/ReportBasis.cs index 25c93a8f2..bccba0419 100644 --- a/lending/Codat/Lending/Models/Components/ReportBasis.cs +++ b/lending/Codat/Lending/Models/Components/ReportBasis.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The basis of a report. /// @@ -58,5 +58,4 @@ public static ReportBasis ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ReportBasis"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ReportComponentMeasure.cs b/lending/Codat/Lending/Models/Components/ReportComponentMeasure.cs index 6b13d8254..0584ac475 100644 --- a/lending/Codat/Lending/Models/Components/ReportComponentMeasure.cs +++ b/lending/Codat/Lending/Models/Components/ReportComponentMeasure.cs @@ -11,24 +11,23 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ReportComponentMeasure { - /// - /// The measure's index. + /// The measure's index. /// [JsonProperty("index")] public long? Index { get; set; } /// - /// The measure's display name. + /// The measure's display name. /// [JsonProperty("measureDisplayName")] public string? MeasureDisplayName { get; set; } /// - /// The measure's value. + /// The measure's value. /// [JsonProperty("value")] public decimal? Value { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ReportGenerationPayload.cs b/lending/Codat/Lending/Models/Components/ReportGenerationPayload.cs index b85063205..3816cc225 100644 --- a/lending/Codat/Lending/Models/Components/ReportGenerationPayload.cs +++ b/lending/Codat/Lending/Models/Components/ReportGenerationPayload.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ReportGenerationPayload { - /// /// Unique identifier of the report. /// diff --git a/lending/Codat/Lending/Models/Components/ReportInfo.cs b/lending/Codat/Lending/Models/Components/ReportInfo.cs index d6835d56b..46f67df9b 100644 --- a/lending/Codat/Lending/Models/Components/ReportInfo.cs +++ b/lending/Codat/Lending/Models/Components/ReportInfo.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Report additional information, which is specific to Lending reports. /// public class ReportInfo { - /// /// The number of the page queried. /// diff --git a/lending/Codat/Lending/Models/Components/ReportInput.cs b/lending/Codat/Lending/Models/Components/ReportInput.cs index 5cc891036..8a6ee46d2 100644 --- a/lending/Codat/Lending/Models/Components/ReportInput.cs +++ b/lending/Codat/Lending/Models/Components/ReportInput.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Accounting method used to prepare the cash flow statement. /// @@ -58,5 +58,4 @@ public static ReportInput ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ReportInput"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ReportItem.cs b/lending/Codat/Lending/Models/Components/ReportItem.cs index 8831357df..0897bc0c9 100644 --- a/lending/Codat/Lending/Models/Components/ReportItem.cs +++ b/lending/Codat/Lending/Models/Components/ReportItem.cs @@ -12,14 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ReportItem { - /// - /// 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:
- /// - /// + /// 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
@@ -38,7 +35,6 @@ public class ReportItem /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ReportItems.cs b/lending/Codat/Lending/Models/Components/ReportItems.cs index 2bb0ee3f0..01bb8a1a5 100644 --- a/lending/Codat/Lending/Models/Components/ReportItems.cs +++ b/lending/Codat/Lending/Models/Components/ReportItems.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ReportItems { - [JsonProperty("loanRef")] public LoanRef? LoanRef { get; set; } @@ -23,9 +22,7 @@ public class ReportItems public ItemRef? ItemRef { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -44,7 +41,6 @@ public class ReportItems /// >
/// > 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. - ///
///
[JsonProperty("date")] public string? Date { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ReportLine.cs b/lending/Codat/Lending/Models/Components/ReportLine.cs index 9dc266448..0e88b5ff6 100644 --- a/lending/Codat/Lending/Models/Components/ReportLine.cs +++ b/lending/Codat/Lending/Models/Components/ReportLine.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ReportLine { - /// /// Identifier for the account, unique for the company in the accounting software. /// diff --git a/lending/Codat/Lending/Models/Components/ReportOperation.cs b/lending/Codat/Lending/Models/Components/ReportOperation.cs index 6a139238d..7a3df5064 100644 --- a/lending/Codat/Lending/Models/Components/ReportOperation.cs +++ b/lending/Codat/Lending/Models/Components/ReportOperation.cs @@ -12,15 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Information about report generation. /// public class ReportOperation { - /// - /// Unique identifier of the report + /// Unique identifier of the report. /// [JsonProperty("id")] public string? Id { get; set; } @@ -38,9 +37,7 @@ public class ReportOperation public ReportOperationType? Type { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -59,15 +56,12 @@ public class ReportOperation /// >
/// > 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. - ///
///
[JsonProperty("requestedDate")] public string? RequestedDate { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -86,7 +80,6 @@ public class ReportOperation /// >
/// > 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. - ///
///
[JsonProperty("updatedDate")] public string? UpdatedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ReportOperationStatus.cs b/lending/Codat/Lending/Models/Components/ReportOperationStatus.cs index d9b2d9d5f..184cb7a3c 100644 --- a/lending/Codat/Lending/Models/Components/ReportOperationStatus.cs +++ b/lending/Codat/Lending/Models/Components/ReportOperationStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The status of the report generation. /// @@ -58,5 +58,4 @@ public static ReportOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ReportOperationStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ReportOperationType.cs b/lending/Codat/Lending/Models/Components/ReportOperationType.cs index 3b599a536..6833d1efb 100644 --- a/lending/Codat/Lending/Models/Components/ReportOperationType.cs +++ b/lending/Codat/Lending/Models/Components/ReportOperationType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The name of the generated report. /// @@ -58,5 +58,4 @@ public static ReportOperationType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ReportOperationType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ReportSourceReference.cs b/lending/Codat/Lending/Models/Components/ReportSourceReference.cs index 21b6c4aea..d18fbeb55 100644 --- a/lending/Codat/Lending/Models/Components/ReportSourceReference.cs +++ b/lending/Codat/Lending/Models/Components/ReportSourceReference.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// A source reference containing the `sourceType` object "Banking". + /// A source reference containing the `sourceType` object "Banking". /// public class ReportSourceReference { - /// /// The data source type. /// diff --git a/lending/Codat/Lending/Models/Components/ReportType.cs b/lending/Codat/Lending/Models/Components/ReportType.cs index 679a5bc82..ed5934bc9 100644 --- a/lending/Codat/Lending/Models/Components/ReportType.cs +++ b/lending/Codat/Lending/Models/Components/ReportType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + public enum ReportType { [JsonProperty("categorizedBankStatement")] @@ -53,5 +53,4 @@ public static ReportType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ReportType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/Reports.cs b/lending/Codat/Lending/Models/Components/Reports.cs index a5f54e233..326dccc28 100644 --- a/lending/Codat/Lending/Models/Components/Reports.cs +++ b/lending/Codat/Lending/Models/Components/Reports.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Reports { - [JsonProperty("results")] public List? Results { get; set; } diff --git a/lending/Codat/Lending/Models/Components/RoutingInfo.cs b/lending/Codat/Lending/Models/Components/RoutingInfo.cs index 05ef0326c..de1c6d956 100644 --- a/lending/Codat/Lending/Models/Components/RoutingInfo.cs +++ b/lending/Codat/Lending/Models/Components/RoutingInfo.cs @@ -12,15 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Routing information for the bank. This does not include account number. /// public class RoutingInfo { - /// - /// The numeric identifier of the routing number + /// The numeric identifier of the routing number. /// [JsonProperty("bankCode")] public string? BankCode { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/RoutingInfoType.cs b/lending/Codat/Lending/Models/Components/RoutingInfoType.cs index 4b48860dd..b57bb5cb8 100644 --- a/lending/Codat/Lending/Models/Components/RoutingInfoType.cs +++ b/lending/Codat/Lending/Models/Components/RoutingInfoType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of routing number. /// @@ -78,5 +78,4 @@ public static RoutingInfoType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum RoutingInfoType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/SalesOrderReference.cs b/lending/Codat/Lending/Models/Components/SalesOrderReference.cs index de0cb1bca..be4ba8760 100644 --- a/lending/Codat/Lending/Models/Components/SalesOrderReference.cs +++ b/lending/Codat/Lending/Models/Components/SalesOrderReference.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class SalesOrderReference { - /// /// Unique identifier to a record in `dataType`. /// diff --git a/lending/Codat/Lending/Models/Components/Schema.cs b/lending/Codat/Lending/Models/Components/Schema.cs index 9d1a35be7..20994bf92 100644 --- a/lending/Codat/Lending/Models/Components/Schema.cs +++ b/lending/Codat/Lending/Models/Components/Schema.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class Schema { - /// /// Unique identifier of the event. /// @@ -29,9 +28,7 @@ public class Schema public string? EventType { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -50,7 +47,6 @@ public class Schema /// >
/// > 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. - ///
///
[JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Security.cs b/lending/Codat/Lending/Models/Components/Security.cs index 8a3d4c199..837e248a9 100644 --- a/lending/Codat/Lending/Models/Components/Security.cs +++ b/lending/Codat/Lending/Models/Components/Security.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; - + public class Security { - [SpeakeasyMetadata("security:scheme=true,type=apiKey,subType=header,name=Authorization")] public string AuthHeader { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Components/ServiceCharge.cs b/lending/Codat/Lending/Models/Components/ServiceCharge.cs index 58b1c90ab..807ca2ffe 100644 --- a/lending/Codat/Lending/Models/Components/ServiceCharge.cs +++ b/lending/Codat/Lending/Models/Components/ServiceCharge.cs @@ -13,10 +13,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class ServiceCharge { - /// /// Service charges for this order. /// diff --git a/lending/Codat/Lending/Models/Components/ServiceChargeType.cs b/lending/Codat/Lending/Models/Components/ServiceChargeType.cs index 6286a7a13..c8772a7f9 100644 --- a/lending/Codat/Lending/Models/Components/ServiceChargeType.cs +++ b/lending/Codat/Lending/Models/Components/ServiceChargeType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of the service charge. /// @@ -60,5 +60,4 @@ public static ServiceChargeType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ServiceChargeType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/Source.cs b/lending/Codat/Lending/Models/Components/Source.cs index cc7b1abdc..247058628 100644 --- a/lending/Codat/Lending/Models/Components/Source.cs +++ b/lending/Codat/Lending/Models/Components/Source.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// The source of the banking data that determines its format + /// The source of the banking data that determines its format. /// public enum Source { @@ -54,5 +54,4 @@ public static Source ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Source"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/SourceAccount.cs b/lending/Codat/Lending/Models/Components/SourceAccount.cs index 87fbd6507..89e1cac57 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccount.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccount.cs @@ -12,13 +12,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The target bank account in a supported accounting software for ingestion into a bank feed. /// public class SourceAccount { - /// /// Unique ID for the bank account. /// @@ -51,15 +50,12 @@ public class SourceAccount /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -71,9 +67,7 @@ public class SourceAccount public decimal? Balance { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -92,7 +86,6 @@ public class SourceAccount /// >
/// > 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. - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -104,9 +97,7 @@ public class SourceAccount public SourceAccountStatus? Status { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -125,7 +116,6 @@ public class SourceAccount /// >
/// > 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. - ///
///
[JsonProperty("feedStartDate")] public string? FeedStartDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/SourceAccountPrototype.cs b/lending/Codat/Lending/Models/Components/SourceAccountPrototype.cs index 8dea09610..fd443e5cb 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccountPrototype.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccountPrototype.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class SourceAccountPrototype { - /// /// Unique ID for the bank account. /// @@ -47,15 +46,12 @@ public class SourceAccountPrototype /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } @@ -67,9 +63,7 @@ public class SourceAccountPrototype public decimal? Balance { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -88,7 +82,6 @@ public class SourceAccountPrototype /// >
/// > 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. - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/SourceAccountStatus.cs b/lending/Codat/Lending/Models/Components/SourceAccountStatus.cs index 0fc7c74d8..9792e42d2 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccountStatus.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccountStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the source account. /// @@ -62,5 +62,4 @@ public static SourceAccountStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceAccountStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/SourceAccountV2.cs b/lending/Codat/Lending/Models/Components/SourceAccountV2.cs index 9bea0c456..5045d10e6 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccountV2.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccountV2.cs @@ -12,13 +12,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// The target bank account in a supported accounting software for ingestion into a bank feed. /// public class SourceAccountV2 { - /// /// Unique ID for the bank account. /// @@ -57,15 +56,12 @@ public class SourceAccountV2 /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; @@ -80,9 +76,7 @@ public class SourceAccountV2 public AccountInfo? AccountInfo { get; set; } = null; /// - /// 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:
- /// - /// + /// 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
@@ -101,7 +95,6 @@ public class SourceAccountV2 /// >
/// > 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. - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } @@ -113,13 +106,10 @@ public class SourceAccountV2 public SourceAccountV2Status? Status { get; set; } = null; /// - /// In Codat's data model, dates are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date fields are formatted as strings; for example:
- /// - /// + /// In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
/// ```
/// 2020-10-08
/// ``` - ///
///
[JsonProperty("feedStartDate")] public string? FeedStartDate { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/SourceAccountV2AccountType.cs b/lending/Codat/Lending/Models/Components/SourceAccountV2AccountType.cs index 552d0e43a..877a5da3a 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccountV2AccountType.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccountV2AccountType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard. /// @@ -62,5 +62,4 @@ public static SourceAccountV2AccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceAccountV2AccountType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/SourceAccountV2Prototype.cs b/lending/Codat/Lending/Models/Components/SourceAccountV2Prototype.cs index 64aa46b00..00dec3d93 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccountV2Prototype.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccountV2Prototype.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class SourceAccountV2Prototype { - /// /// Unique ID for the bank account. /// @@ -54,15 +53,12 @@ public class SourceAccountV2Prototype /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string Currency { get; set; } = default!; @@ -74,9 +70,7 @@ public class SourceAccountV2Prototype public decimal Balance { get; set; } = default!; /// - /// 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:
- /// - /// + /// 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
@@ -95,7 +89,6 @@ public class SourceAccountV2Prototype /// >
/// > 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. - ///
///
[JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Components/SourceAccountV2Status.cs b/lending/Codat/Lending/Models/Components/SourceAccountV2Status.cs index c6844e5bd..44288d486 100644 --- a/lending/Codat/Lending/Models/Components/SourceAccountV2Status.cs +++ b/lending/Codat/Lending/Models/Components/SourceAccountV2Status.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the source account. /// @@ -62,5 +62,4 @@ public static SourceAccountV2Status ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceAccountV2Status"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/SourceRef.cs b/lending/Codat/Lending/Models/Components/SourceRef.cs index df03b6d69..ef196ceb5 100644 --- a/lending/Codat/Lending/Models/Components/SourceRef.cs +++ b/lending/Codat/Lending/Models/Components/SourceRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// A source reference containing the `sourceType` object "Banking". + /// A source reference containing the `sourceType` object "Banking". /// public class SourceRef { - /// /// The data source type. /// diff --git a/lending/Codat/Lending/Models/Components/SourceType.cs b/lending/Codat/Lending/Models/Components/SourceType.cs index fc66a9fb0..0f7af5f88 100644 --- a/lending/Codat/Lending/Models/Components/SourceType.cs +++ b/lending/Codat/Lending/Models/Components/SourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of platform of the connection. /// @@ -66,5 +66,4 @@ public static SourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/StartUploadSessionRequest.cs b/lending/Codat/Lending/Models/Components/StartUploadSessionRequest.cs index 4d7df92c7..099ade576 100644 --- a/lending/Codat/Lending/Models/Components/StartUploadSessionRequest.cs +++ b/lending/Codat/Lending/Models/Components/StartUploadSessionRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class StartUploadSessionRequest { - /// /// A key for a Codat data type. /// diff --git a/lending/Codat/Lending/Models/Components/StartUploadSessionRequestDataType.cs b/lending/Codat/Lending/Models/Components/StartUploadSessionRequestDataType.cs index 8f76d0b79..c1aca5486 100644 --- a/lending/Codat/Lending/Models/Components/StartUploadSessionRequestDataType.cs +++ b/lending/Codat/Lending/Models/Components/StartUploadSessionRequestDataType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// A key for a Codat data type. /// @@ -56,5 +56,4 @@ public static StartUploadSessionRequestDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum StartUploadSessionRequestDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/Status.cs b/lending/Codat/Lending/Models/Components/Status.cs index 9f7546be8..3505ea39d 100644 --- a/lending/Codat/Lending/Models/Components/Status.cs +++ b/lending/Codat/Lending/Models/Components/Status.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The current status of the dataset. /// @@ -94,5 +94,4 @@ public static Status ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Status"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/SupplementalData.cs b/lending/Codat/Lending/Models/Components/SupplementalData.cs index a2e705899..20b5e8526 100644 --- a/lending/Codat/Lending/Models/Components/SupplementalData.cs +++ b/lending/Codat/Lending/Models/Components/SupplementalData.cs @@ -12,18 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// 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 about supplemental data. - ///
///
public class SupplementalData { - [JsonProperty("content")] public Dictionary>? Content { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Components/SupplierRef.cs b/lending/Codat/Lending/Models/Components/SupplierRef.cs index 28d42e847..b811b4c49 100644 --- a/lending/Codat/Lending/Models/Components/SupplierRef.cs +++ b/lending/Codat/Lending/Models/Components/SupplierRef.cs @@ -11,21 +11,20 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Reference to the supplier the record relates to. /// public class SupplierRef { - /// - /// The supplier's unique ID + /// The supplier's unique ID. /// [JsonProperty("id")] public string Id { get; set; } = default!; /// - /// The supplier's name + /// The supplier's name. /// [JsonProperty("supplierName")] public string? SupplierName { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/SupplierStatus.cs b/lending/Codat/Lending/Models/Components/SupplierStatus.cs index bce625e8c..1ef91f654 100644 --- a/lending/Codat/Lending/Models/Components/SupplierStatus.cs +++ b/lending/Codat/Lending/Models/Components/SupplierStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Status of the supplier. /// @@ -58,5 +58,4 @@ public static SupplierStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SupplierStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/TargetAccountOption.cs b/lending/Codat/Lending/Models/Components/TargetAccountOption.cs index 9d19bbf59..f1e9823d4 100644 --- a/lending/Codat/Lending/Models/Components/TargetAccountOption.cs +++ b/lending/Codat/Lending/Models/Components/TargetAccountOption.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class TargetAccountOption { - /// /// Id of the target account. /// diff --git a/lending/Codat/Lending/Models/Components/TaxComponentAllocation.cs b/lending/Codat/Lending/Models/Components/TaxComponentAllocation.cs index bf0903ed9..b4f83cd7b 100644 --- a/lending/Codat/Lending/Models/Components/TaxComponentAllocation.cs +++ b/lending/Codat/Lending/Models/Components/TaxComponentAllocation.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class TaxComponentAllocation { - /// /// Taxes rates reference object depending on the rates being available on source commerce software. /// diff --git a/lending/Codat/Lending/Models/Components/TaxComponentRef.cs b/lending/Codat/Lending/Models/Components/TaxComponentRef.cs index f77efde7d..4d8b10fca 100644 --- a/lending/Codat/Lending/Models/Components/TaxComponentRef.cs +++ b/lending/Codat/Lending/Models/Components/TaxComponentRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Taxes rates reference object depending on the rates being available on source commerce software. /// public class TaxComponentRef { - /// /// The unique identitifer of the tax component being referenced. /// diff --git a/lending/Codat/Lending/Models/Components/TaxRateRef.cs b/lending/Codat/Lending/Models/Components/TaxRateRef.cs index ea2a58b73..33a2b53cb 100644 --- a/lending/Codat/Lending/Models/Components/TaxRateRef.cs +++ b/lending/Codat/Lending/Models/Components/TaxRateRef.cs @@ -11,11 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -24,12 +22,10 @@ namespace Codat.Lending.Models.Components /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
public class TaxRateRef { - /// /// Unique identifier for the tax rate in the accounting software. /// diff --git a/lending/Codat/Lending/Models/Components/TaxRateReference.cs b/lending/Codat/Lending/Models/Components/TaxRateReference.cs index 64d648f5c..e59116789 100644 --- a/lending/Codat/Lending/Models/Components/TaxRateReference.cs +++ b/lending/Codat/Lending/Models/Components/TaxRateReference.cs @@ -11,11 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
- /// - /// ///
/// Found on:
///
@@ -24,12 +22,10 @@ namespace Codat.Lending.Models.Components /// - Credit Note line items
/// - Direct incomes line items
/// - Invoice line items
- /// - Items - ///
+ /// - Items. ///
public class TaxRateReference { - /// /// Unique identifier for the tax rate in the accounting software. /// diff --git a/lending/Codat/Lending/Models/Components/Tracking.cs b/lending/Codat/Lending/Models/Components/Tracking.cs index b1ea8675e..45d21a8ed 100644 --- a/lending/Codat/Lending/Models/Components/Tracking.cs +++ b/lending/Codat/Lending/Models/Components/Tracking.cs @@ -13,20 +13,16 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class Tracking { - [JsonProperty("recordRefs")] public List RecordRefs { get; set; } = default!; /// /// Links the current record to the underlying record or data type that created it.
- /// - /// ///
- /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - ///
+ /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. ///
[JsonProperty("invoiceTo")] public AccountingRecordRef? InvoiceTo { get; set; } diff --git a/lending/Codat/Lending/Models/Components/TrackingCategoryRef.cs b/lending/Codat/Lending/Models/Components/TrackingCategoryRef.cs index f1f822e7f..f1bd43940 100644 --- a/lending/Codat/Lending/Models/Components/TrackingCategoryRef.cs +++ b/lending/Codat/Lending/Models/Components/TrackingCategoryRef.cs @@ -12,14 +12,13 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// References a category against which the item is tracked. /// [Obsolete("This will be removed in a future release, please migrate away from it as soon as possible")] public class TrackingCategoryRef { - /// /// Unique identifier to the tracking category. /// diff --git a/lending/Codat/Lending/Models/Components/TrackingRecordRef.cs b/lending/Codat/Lending/Models/Components/TrackingRecordRef.cs index a355e0090..55390d9a1 100644 --- a/lending/Codat/Lending/Models/Components/TrackingRecordRef.cs +++ b/lending/Codat/Lending/Models/Components/TrackingRecordRef.cs @@ -12,15 +12,14 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links to the customer or tracking category. /// public class TrackingRecordRef { - /// - /// 'id' of the underlying record or data type. + /// 'id' of the underlying record or data type. /// [JsonProperty("id")] public string? Id { get; set; } diff --git a/lending/Codat/Lending/Models/Components/TrackingRecordRefDataType.cs b/lending/Codat/Lending/Models/Components/TrackingRecordRefDataType.cs index c96886abc..5305a8671 100644 --- a/lending/Codat/Lending/Models/Components/TrackingRecordRefDataType.cs +++ b/lending/Codat/Lending/Models/Components/TrackingRecordRefDataType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Name of underlying data type. /// @@ -58,5 +58,4 @@ public static TrackingRecordRefDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TrackingRecordRefDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/TransactionCategory.cs b/lending/Codat/Lending/Models/Components/TransactionCategory.cs index 3111e50d6..41b9dc8c9 100644 --- a/lending/Codat/Lending/Models/Components/TransactionCategory.cs +++ b/lending/Codat/Lending/Models/Components/TransactionCategory.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + public class TransactionCategory { - /// /// Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100. /// diff --git a/lending/Codat/Lending/Models/Components/TransactionCategoryRef.cs b/lending/Codat/Lending/Models/Components/TransactionCategoryRef.cs index 21518e6f2..e2b63883e 100644 --- a/lending/Codat/Lending/Models/Components/TransactionCategoryRef.cs +++ b/lending/Codat/Lending/Models/Components/TransactionCategoryRef.cs @@ -11,13 +11,12 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// An object of bank transaction category reference data. /// public class TransactionCategoryRef { - /// /// The unique category reference id for the bank transaction. /// diff --git a/lending/Codat/Lending/Models/Components/TransactionCategoryStatus.cs b/lending/Codat/Lending/Models/Components/TransactionCategoryStatus.cs index e73fce7d6..1b58e4ee9 100644 --- a/lending/Codat/Lending/Models/Components/TransactionCategoryStatus.cs +++ b/lending/Codat/Lending/Models/Components/TransactionCategoryStatus.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The status of the transaction category. /// @@ -58,5 +58,4 @@ public static TransactionCategoryStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TransactionCategoryStatus"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/TransactionCode.cs b/lending/Codat/Lending/Models/Components/TransactionCode.cs index 5b030c789..2456f0fbd 100644 --- a/lending/Codat/Lending/Models/Components/TransactionCode.cs +++ b/lending/Codat/Lending/Models/Components/TransactionCode.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Code to identify the underlying transaction. /// @@ -82,5 +82,4 @@ public static TransactionCode ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TransactionCode"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/TransactionSourceRef.cs b/lending/Codat/Lending/Models/Components/TransactionSourceRef.cs index b46b2ff9d..4751b3c49 100644 --- a/lending/Codat/Lending/Models/Components/TransactionSourceRef.cs +++ b/lending/Codat/Lending/Models/Components/TransactionSourceRef.cs @@ -12,12 +12,11 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class TransactionSourceRef { - /// - /// The unique identitifer of the record being referenced + /// The unique identitifer of the record being referenced. /// [JsonProperty("id")] public string Id { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Components/TransactionSourceType.cs b/lending/Codat/Lending/Models/Components/TransactionSourceType.cs index 2118eb370..1f8786231 100644 --- a/lending/Codat/Lending/Models/Components/TransactionSourceType.cs +++ b/lending/Codat/Lending/Models/Components/TransactionSourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of source the transaction arose. /// @@ -62,5 +62,4 @@ public static TransactionSourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TransactionSourceType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/TransactionType.cs b/lending/Codat/Lending/Models/Components/TransactionType.cs index 1a2319357..eb0a68696 100644 --- a/lending/Codat/Lending/Models/Components/TransactionType.cs +++ b/lending/Codat/Lending/Models/Components/TransactionType.cs @@ -12,20 +12,17 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of the platform transaction:
- /// - /// /// - `Unknown`
- /// - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
+ /// - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
/// - `Payment` — Credit and debit card payments.
- /// - `PaymentFee` — Payment provider's fee on each card payment.
- /// - `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
- /// - `Payout` — Transfer of funds from the seller's merchant account to their bank account.
- /// - `Refund` — Refunds to a customer's credit or debit card.
- /// - `Transfer` — Secure transfer of funds to the seller's bank account. - ///
+ /// - `PaymentFee` — Payment provider's fee on each card payment.
+ /// - `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
+ /// - `Payout` — Transfer of funds from the seller's merchant account to their bank account.
+ /// - `Refund` — Refunds to a customer's credit or debit card.
+ /// - `Transfer` — Secure transfer of funds to the seller's bank account. ///
public enum TransactionType { @@ -79,5 +76,4 @@ public static TransactionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum TransactionType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/TransferAccount.cs b/lending/Codat/Lending/Models/Components/TransferAccount.cs index 21e375be3..f671f465b 100644 --- a/lending/Codat/Lending/Models/Components/TransferAccount.cs +++ b/lending/Codat/Lending/Models/Components/TransferAccount.cs @@ -12,35 +12,28 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Account details of the account sending or receiving the transfer. /// public class TransferAccount { - /// /// Links the current record to the underlying record or data type that created it.
- /// - /// ///
- /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - ///
+ /// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. ///
[JsonProperty("accountRef")] public AccountingRecordRef? AccountRef { get; set; } /// /// The currency data type in Codat is the 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. - ///
///
[JsonProperty("currency")] public string? Currency { get; set; } diff --git a/lending/Codat/Lending/Models/Components/Type.cs b/lending/Codat/Lending/Models/Components/Type.cs index 1bbbe5d9e..3dd79e571 100644 --- a/lending/Codat/Lending/Models/Components/Type.cs +++ b/lending/Codat/Lending/Models/Components/Type.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// The type of phone number + /// The type of phone number. /// public enum Type { @@ -62,5 +62,4 @@ public static Type ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Type"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/ValidDataTypeLinks.cs b/lending/Codat/Lending/Models/Components/ValidDataTypeLinks.cs index fec3a60a4..217c3310f 100644 --- a/lending/Codat/Lending/Models/Components/ValidDataTypeLinks.cs +++ b/lending/Codat/Lending/Models/Components/ValidDataTypeLinks.cs @@ -12,11 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// - /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
- /// - /// + /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
///
/// For example, `validDatatypeLinks` might indicate the following references:
///
@@ -31,18 +29,18 @@ namespace Codat.Lending.Models.Components ///
/// ```json validDatatypeLinks for an account
/// {
- /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
- /// "nominalCode": "090",
- /// "name": "Business Bank Account",
+ /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ /// "nominalCode": "090",
+ /// "name": "Business Bank Account",
/// #...
- /// "validDatatypeLinks": [
+ /// "validDatatypeLinks": [
/// {
- /// "property": "Id",
- /// "links": [
- /// "Payment.AccountRef.Id",
- /// "BillPayment.AccountRef.Id",
- /// "DirectIncome.LineItems.AccountRef.Id",
- /// "DirectCost.LineItems.AccountRef.Id"
+ /// "property": "Id",
+ /// "links": [
+ /// "Payment.AccountRef.Id",
+ /// "BillPayment.AccountRef.Id",
+ /// "DirectIncome.LineItems.AccountRef.Id",
+ /// "DirectCost.LineItems.AccountRef.Id"
/// ]
/// }
/// ]
@@ -55,12 +53,10 @@ namespace Codat.Lending.Models.Components ///
/// Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations.
///
- /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>. - ///
+ /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. ///
public class ValidDataTypeLinks { - /// /// The property from the account that can be linked. /// diff --git a/lending/Codat/Lending/Models/Components/Validation.cs b/lending/Codat/Lending/Models/Components/Validation.cs index e37b7cccb..539e4defb 100644 --- a/lending/Codat/Lending/Models/Components/Validation.cs +++ b/lending/Codat/Lending/Models/Components/Validation.cs @@ -13,13 +13,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System.Collections.Generic; - + /// /// 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. /// public class Validation { - [JsonProperty("errors")] public List? Errors { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/ValidationItem.cs b/lending/Codat/Lending/Models/Components/ValidationItem.cs index eaa7ac591..d7f9dbb39 100644 --- a/lending/Codat/Lending/Models/Components/ValidationItem.cs +++ b/lending/Codat/Lending/Models/Components/ValidationItem.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ValidationItem { - /// /// Unique identifier for a validation item. /// @@ -22,7 +21,7 @@ public class ValidationItem public string? ItemId { get; set; } = null; /// - /// A message outlining validation item's issue. + /// A message outlining validation item's issue. /// [JsonProperty("message")] public string? Message { get; set; } = null; diff --git a/lending/Codat/Lending/Models/Components/WebLink.cs b/lending/Codat/Lending/Models/Components/WebLink.cs index 0acf24051..36217b7f2 100644 --- a/lending/Codat/Lending/Models/Components/WebLink.cs +++ b/lending/Codat/Lending/Models/Components/WebLink.cs @@ -12,13 +12,12 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Weblink associated with the company. /// public class WebLink { - /// /// The type of the weblink. /// diff --git a/lending/Codat/Lending/Models/Components/WebLinkType.cs b/lending/Codat/Lending/Models/Components/WebLinkType.cs index 53a3ca502..338ea4aef 100644 --- a/lending/Codat/Lending/Models/Components/WebLinkType.cs +++ b/lending/Codat/Lending/Models/Components/WebLinkType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// The type of the weblink. /// @@ -58,5 +58,4 @@ public static WebLinkType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum WebLinkType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Components/WithholdingTax.cs b/lending/Codat/Lending/Models/Components/WithholdingTax.cs index a08c4ba9b..f575a1cc1 100644 --- a/lending/Codat/Lending/Models/Components/WithholdingTax.cs +++ b/lending/Codat/Lending/Models/Components/WithholdingTax.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Components { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class WithholdingTax { - /// /// Name assigned to withheld tax. /// diff --git a/lending/Codat/Lending/Models/Components/Zero.cs b/lending/Codat/Lending/Models/Components/Zero.cs index 7a867fc0f..913453a24 100644 --- a/lending/Codat/Lending/Models/Components/Zero.cs +++ b/lending/Codat/Lending/Models/Components/Zero.cs @@ -12,26 +12,22 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// /// Links the current record line to the underlying record line that created it.
- /// - /// ///
- /// For example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. - ///
+ /// For example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. ///
public class Zero { - /// - /// 'id' of the underlying record. + /// 'id' of the underlying record. /// [JsonProperty("id")] public string? Id { get; set; } /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// [JsonProperty("dataType")] public ZeroDataType? DataType { get; set; } diff --git a/lending/Codat/Lending/Models/Components/ZeroDataType.cs b/lending/Codat/Lending/Models/Components/ZeroDataType.cs index a940d3cac..db19da058 100644 --- a/lending/Codat/Lending/Models/Components/ZeroDataType.cs +++ b/lending/Codat/Lending/Models/Components/ZeroDataType.cs @@ -12,9 +12,9 @@ namespace Codat.Lending.Models.Components using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// - /// Allowed name of the 'dataType'. + /// Allowed name of the 'dataType'. /// public enum ZeroDataType { @@ -56,5 +56,4 @@ public static ZeroDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ZeroDataType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Errors/CodatLendingException.cs b/lending/Codat/Lending/Models/Errors/CodatLendingException.cs index 7f5c9db11..d5b3675a9 100644 --- a/lending/Codat/Lending/Models/Errors/CodatLendingException.cs +++ b/lending/Codat/Lending/Models/Errors/CodatLendingException.cs @@ -14,6 +14,9 @@ namespace Codat.Lending.Models.Errors using System.Net.Http; using System.Net.Http.Headers; + /// + /// Base Exception for API Errors. + /// public class CodatLendingException : Exception { /// diff --git a/lending/Codat/Lending/Models/Errors/ErrorMessage.cs b/lending/Codat/Lending/Models/Errors/ErrorMessage.cs index ea021a493..e4a7a4cbd 100644 --- a/lending/Codat/Lending/Models/Errors/ErrorMessage.cs +++ b/lending/Codat/Lending/Models/Errors/ErrorMessage.cs @@ -24,7 +24,7 @@ public class ErrorMessagePayload public long? StatusCode { get; set; } /// - /// Codat's service the returned the error. + /// Codat's service the returned the error. /// [JsonProperty("service")] public string? Service { get; set; } @@ -61,7 +61,7 @@ public class ErrorMessagePayload } /// - /// Your `query` parameter was not correctly formed + /// Your `query` parameter was not correctly formed. /// public class ErrorMessage : CodatLendingException { @@ -106,5 +106,4 @@ string body #pragma warning restore CS0618 } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Errors/SDKException.cs b/lending/Codat/Lending/Models/Errors/SDKException.cs index 052521656..d61a90114 100644 --- a/lending/Codat/Lending/Models/Errors/SDKException.cs +++ b/lending/Codat/Lending/Models/Errors/SDKException.cs @@ -13,6 +13,9 @@ namespace Codat.Lending.Models.Errors using System; using System.Net.Http; + /// + /// Default API Exception. + /// public class SDKException : CodatLendingException { /// diff --git a/lending/Codat/Lending/Models/Requests/CreateAccountRequest.cs b/lending/Codat/Lending/Models/Requests/CreateAccountRequest.cs index 2ea97d0c4..8a4c32356 100644 --- a/lending/Codat/Lending/Models/Requests/CreateAccountRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateAccountRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateAccountResponse.cs b/lending/Codat/Lending/Models/Requests/CreateAccountResponse.cs index 961a998a3..b8cc64f2b 100644 --- a/lending/Codat/Lending/Models/Requests/CreateAccountResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateAccountResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreateAccountResponse? AccountingCreateAccountResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingRequest.cs b/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingRequest.cs index afcff73fb..894d19535 100644 --- a/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateBankAccountMappingRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingResponse.cs b/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingResponse.cs index ca9a83e84..c10cae54f 100644 --- a/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateBankAccountMappingResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateBankAccountMappingResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankFeedBankAccountMappingResponse? BankFeedBankAccountMappingResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateBankAccountRequest.cs b/lending/Codat/Lending/Models/Requests/CreateBankAccountRequest.cs index c9ad29516..fed892cf9 100644 --- a/lending/Codat/Lending/Models/Requests/CreateBankAccountRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateBankAccountRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateBankAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateBankAccountResponse.cs b/lending/Codat/Lending/Models/Requests/CreateBankAccountResponse.cs index c642d5cb0..9f1934c3d 100644 --- a/lending/Codat/Lending/Models/Requests/CreateBankAccountResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateBankAccountResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateBankAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreateBankAccountResponse? AccountingCreateBankAccountResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateBankTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/CreateBankTransactionsRequest.cs index e11e4368c..a789f572c 100644 --- a/lending/Codat/Lending/Models/Requests/CreateBankTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateBankTransactionsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateBankTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateBankTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/CreateBankTransactionsResponse.cs index 9107b0f70..2eaa739c3 100644 --- a/lending/Codat/Lending/Models/Requests/CreateBankTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateBankTransactionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateBankTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreateBankTransactionsResponse? AccountingCreateBankTransactionsResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateCompanyResponse.cs b/lending/Codat/Lending/Models/Requests/CreateCompanyResponse.cs index 968df138a..db654687c 100644 --- a/lending/Codat/Lending/Models/Requests/CreateCompanyResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateCompanyResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateConnectionRequest.cs b/lending/Codat/Lending/Models/Requests/CreateConnectionRequest.cs index fbd0175de..2f7a4a3f1 100644 --- a/lending/Codat/Lending/Models/Requests/CreateConnectionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateConnectionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class CreateConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateConnectionRequestBody.cs b/lending/Codat/Lending/Models/Requests/CreateConnectionRequestBody.cs index cdfd7602c..cdf99407e 100644 --- a/lending/Codat/Lending/Models/Requests/CreateConnectionRequestBody.cs +++ b/lending/Codat/Lending/Models/Requests/CreateConnectionRequestBody.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; using Newtonsoft.Json; - + public class CreateConnectionRequestBody { - /// /// A unique 4-letter key to represent a platform in each integration. View accounting, banking, and commerce platform keys. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateConnectionResponse.cs b/lending/Codat/Lending/Models/Requests/CreateConnectionResponse.cs index d9f6d14a3..389f5818d 100644 --- a/lending/Codat/Lending/Models/Requests/CreateConnectionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateConnectionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Connection? Connection { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateDirectCostRequest.cs b/lending/Codat/Lending/Models/Requests/CreateDirectCostRequest.cs index f8204418b..7f60f3f66 100644 --- a/lending/Codat/Lending/Models/Requests/CreateDirectCostRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateDirectCostRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateDirectCostRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateDirectCostResponse.cs b/lending/Codat/Lending/Models/Requests/CreateDirectCostResponse.cs index 18651950d..0590a7e9a 100644 --- a/lending/Codat/Lending/Models/Requests/CreateDirectCostResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateDirectCostResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateDirectCostResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreateDirectCostResponse? AccountingCreateDirectCostResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreatePaymentRequest.cs b/lending/Codat/Lending/Models/Requests/CreatePaymentRequest.cs index f94bbce87..42d04591b 100644 --- a/lending/Codat/Lending/Models/Requests/CreatePaymentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreatePaymentRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreatePaymentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreatePaymentResponse.cs b/lending/Codat/Lending/Models/Requests/CreatePaymentResponse.cs index 2d68d8bf7..9081a1acc 100644 --- a/lending/Codat/Lending/Models/Requests/CreatePaymentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreatePaymentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreatePaymentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreatePaymentResponse? AccountingCreatePaymentResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequest.cs b/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequest.cs index a3b130f2f..8753934cc 100644 --- a/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Models.Components; using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class CreateSourceAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequestBody.cs b/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequestBody.cs index 9b10c2383..b7472b46f 100644 --- a/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequestBody.cs +++ b/lending/Codat/Lending/Models/Requests/CreateSourceAccountRequestBody.cs @@ -52,7 +52,6 @@ public override int GetHashCode() } } - [JsonConverter(typeof(CreateSourceAccountRequestBody.CreateSourceAccountRequestBodyConverter))] public class CreateSourceAccountRequestBody { diff --git a/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponse.cs b/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponse.cs index d94098db4..6104b042b 100644 --- a/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponse.cs @@ -14,27 +14,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateSourceAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public CreateSourceAccountResponseBody? OneOf { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponseBody.cs b/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponseBody.cs index 3b7e80a79..859514e03 100644 --- a/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponseBody.cs +++ b/lending/Codat/Lending/Models/Requests/CreateSourceAccountResponseBody.cs @@ -52,9 +52,8 @@ public override int GetHashCode() } } - /// - /// Success + /// Success. /// [JsonConverter(typeof(CreateSourceAccountResponseBody.CreateSourceAccountResponseBodyConverter))] public class CreateSourceAccountResponseBody diff --git a/lending/Codat/Lending/Models/Requests/CreateSupplierRequest.cs b/lending/Codat/Lending/Models/Requests/CreateSupplierRequest.cs index 221d6d2a8..a1132a048 100644 --- a/lending/Codat/Lending/Models/Requests/CreateSupplierRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateSupplierRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateSupplierRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateSupplierResponse.cs b/lending/Codat/Lending/Models/Requests/CreateSupplierResponse.cs index a4b65864a..c16618287 100644 --- a/lending/Codat/Lending/Models/Requests/CreateSupplierResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateSupplierResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateSupplierResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreateSupplierResponse? AccountingCreateSupplierResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/CreateTransferRequest.cs b/lending/Codat/Lending/Models/Requests/CreateTransferRequest.cs index 6bac05ecd..774de836b 100644 --- a/lending/Codat/Lending/Models/Requests/CreateTransferRequest.cs +++ b/lending/Codat/Lending/Models/Requests/CreateTransferRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class CreateTransferRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/CreateTransferResponse.cs b/lending/Codat/Lending/Models/Requests/CreateTransferResponse.cs index a88d547cc..d738bf3f4 100644 --- a/lending/Codat/Lending/Models/Requests/CreateTransferResponse.cs +++ b/lending/Codat/Lending/Models/Requests/CreateTransferResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class CreateTransferResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreateTransferResponse? AccountingCreateTransferResponse { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DeleteCompanyRequest.cs b/lending/Codat/Lending/Models/Requests/DeleteCompanyRequest.cs index c146b9dbf..d6c3e53dc 100644 --- a/lending/Codat/Lending/Models/Requests/DeleteCompanyRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DeleteCompanyRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DeleteCompanyRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DeleteCompanyResponse.cs b/lending/Codat/Lending/Models/Requests/DeleteCompanyResponse.cs index abd831a30..cf0205bf4 100644 --- a/lending/Codat/Lending/Models/Requests/DeleteCompanyResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DeleteCompanyResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DeleteCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/DeleteConnectionRequest.cs b/lending/Codat/Lending/Models/Requests/DeleteConnectionRequest.cs index 2f4a339ab..41be064ac 100644 --- a/lending/Codat/Lending/Models/Requests/DeleteConnectionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DeleteConnectionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DeleteConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DeleteConnectionResponse.cs b/lending/Codat/Lending/Models/Requests/DeleteConnectionResponse.cs index 1c3fc64f8..913a67f6d 100644 --- a/lending/Codat/Lending/Models/Requests/DeleteConnectionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DeleteConnectionResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DeleteConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentRequest.cs index af1a1edfb..ff7b04ece 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingBillAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentResponse.cs index 1c270dfdd..b593e6109 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingBillAttachmentResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingBillAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentRequest.cs index 8998779d6..ed085e4eb 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingCustomerAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentResponse.cs index 80fedfc1a..732f0e57e 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingCustomerAttachmentResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingCustomerAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.cs index 1c31be926..321eddd89 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingDirectCostAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentResponse.cs index b636ff77d..1dec17970 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectCostAttachmentResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingDirectCostAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.cs index a39b13fef..5f2fe697a 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingDirectIncomeAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentResponse.cs index da8617ac2..b272ead5b 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingDirectIncomeAttachmentResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingDirectIncomeAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.cs index 9fa47af85..cf4e3962c 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingInvoiceAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentResponse.cs index bef8e637b..e55d99a18 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoiceAttachmentResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingInvoiceAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfRequest.cs index 8dd5b1a90..bb7c65e68 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingInvoicePdfRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfResponse.cs index 90738b99e..8037a3226 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingInvoicePdfResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingInvoicePdfResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentRequest.cs index 43d7dafd5..f29ac4f34 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadAccountingSupplierAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentResponse.cs index c2f5da23c..138d7bf2a 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadAccountingSupplierAttachmentResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadAccountingSupplierAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/DownloadExcelReportRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadExcelReportRequest.cs index d060bd70f..4e66e88c5 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadExcelReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadExcelReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class DownloadExcelReportRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadExcelReportResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadExcelReportResponse.cs index 7c32f2bdc..8afad233c 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadExcelReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadExcelReportResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadExcelReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Requests/DownloadFilesRequest.cs b/lending/Codat/Lending/Models/Requests/DownloadFilesRequest.cs index 39aa51d12..c58ee0851 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadFilesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadFilesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class DownloadFilesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/DownloadFilesResponse.cs b/lending/Codat/Lending/Models/Requests/DownloadFilesResponse.cs index f57f4e261..4250c9e0e 100644 --- a/lending/Codat/Lending/Models/Requests/DownloadFilesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/DownloadFilesResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class DownloadFilesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public byte[]? Data { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionRequest.cs b/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionRequest.cs index 03907d3b9..ccb595371 100644 --- a/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class EndBankStatementUploadSessionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionResponse.cs b/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionResponse.cs index b8738a193..ddc918f51 100644 --- a/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/EndBankStatementUploadSessionResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class EndBankStatementUploadSessionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/GenerateExcelReportRequest.cs b/lending/Codat/Lending/Models/Requests/GenerateExcelReportRequest.cs index d496aaa57..6b541626b 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateExcelReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateExcelReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GenerateExcelReportRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GenerateExcelReportResponse.cs b/lending/Codat/Lending/Models/Requests/GenerateExcelReportResponse.cs index 1790f3059..8062dad7b 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateExcelReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateExcelReportResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GenerateExcelReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public ExcelStatus? ExcelStatus { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryQueryParamSourceType.cs b/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryQueryParamSourceType.cs index a149ef97a..a23a8aca2 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryQueryParamSourceType.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryQueryParamSourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Data source type. /// @@ -58,5 +58,4 @@ public static GenerateLoanSummaryQueryParamSourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum GenerateLoanSummaryQueryParamSourceType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryRequest.cs b/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryRequest.cs index dabe7db8b..10c0e3860 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class GenerateLoanSummaryRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryResponse.cs b/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryResponse.cs index 30e14c712..dff008d54 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateLoanSummaryResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GenerateLoanSummaryResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsRequest.cs index 6a3582ae0..ff72fb78f 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class GenerateLoanTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsResponse.cs index 1178aa418..cc9eff7e2 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateLoanTransactionsResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GenerateLoanTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/GenerateReportRequest.cs b/lending/Codat/Lending/Models/Requests/GenerateReportRequest.cs index 3b4a2d72e..afe783b61 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GenerateReportRequest { - /// /// Unique identifier for a company. /// @@ -22,7 +21,7 @@ public class GenerateReportRequest public string CompanyId { get; set; } = default!; /// - /// The type of the report + /// The type of the report. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=reportType")] public ReportType ReportType { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Requests/GenerateReportResponse.cs b/lending/Codat/Lending/Models/Requests/GenerateReportResponse.cs index b23fd6197..1b45219fd 100644 --- a/lending/Codat/Lending/Models/Requests/GenerateReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GenerateReportResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GenerateReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Accepted (pending) + /// Accepted (pending). /// public ReportOperation? ReportOperation { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAccountRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAccountRequest.cs index 536b51993..805f2391c 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAccountRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAccountRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAccountResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAccountResponse.cs index f0330a917..175ff65b7 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAccountResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAccountResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAccount? AccountingAccount { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionRequest.cs index 52d7dce69..b9b7d4730 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingAccountTransactionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionResponse.cs index 53c145ee4..4c8d0959b 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAccountTransactionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingAccountTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAccountTransaction? AccountingAccountTransaction { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportRequest.cs index 7e3271c59..5671187c8 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; using NodaTime; - + public class GetAccountingAgedCreditorsReportRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportResponse.cs index 10acadd84..7fbcd309c 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAgedCreditorsReportResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingAgedCreditorsReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public AccountingAgedCreditorReport? AccountingAgedCreditorReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportRequest.cs index 509fd909b..8a8839b23 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; using NodaTime; - + public class GetAccountingAgedDebtorsReportRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportResponse.cs index 18f84707f..c98500159 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingAgedDebtorsReportResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingAgedDebtorsReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public AccountingAgedDebtorReport? AccountingAgedDebtorReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetRequest.cs index 83a154e37..6d7630a83 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingBalanceSheetRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetResponse.cs index 856a2e8f1..091ea97d1 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBalanceSheetResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingBalanceSheetResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBalanceSheet? AccountingBalanceSheet { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountRequest.cs index fa215bcbf..e9ca960eb 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingBankAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountResponse.cs index 16bc75b62..a97c5fc47 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBankAccountResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingBankAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBankAccount? AccountingBankAccount { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentRequest.cs index aaf2b0e5b..fe3087885 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingBillAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentResponse.cs index 8f04bcb43..740bbbbfc 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillAttachmentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingBillAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAttachment? AccountingAttachment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteRequest.cs index 4f979e0ab..559ed62ac 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingBillCreditNoteRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteResponse.cs index 16541af28..97d91cdce 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillCreditNoteResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingBillCreditNoteResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBillCreditNote? AccountingBillCreditNote { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentRequest.cs index 6243e908c..0d366b747 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingBillPaymentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentResponse.cs index f430546af..f6708efcd 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillPaymentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingBillPaymentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBillPayment? AccountingBillPayment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillRequest.cs index 2c39a2642..24302d3cb 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingBillRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingBillResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingBillResponse.cs index e361c699f..4278de962 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingBillResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingBillResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingBillResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBill? AccountingBill { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementRequest.cs index 62e4e7cdd..a312f5e62 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingCashFlowStatementRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementResponse.cs index ee0587999..7a6b2bdd9 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCashFlowStatementResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingCashFlowStatementResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCashFlowStatement? AccountingCashFlowStatement { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteRequest.cs index 7a2d2f420..d372bc485 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingCreditNoteRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteResponse.cs index 1777e8ef8..d77bb7574 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCreditNoteResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingCreditNoteResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreditNote? AccountingCreditNote { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentRequest.cs index eadc40f30..abaae38a5 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingCustomerAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentResponse.cs index c21068b76..244cc6595 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerAttachmentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingCustomerAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAttachment? AccountingAttachment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerRequest.cs index 9222242be..15558fb6f 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingCustomerRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerResponse.cs index 421b29dbd..983df949b 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingCustomerResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingCustomerResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingCustomerResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCustomer? AccountingCustomer { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentRequest.cs index bb1174534..067ab32a1 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingDirectCostAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentResponse.cs index 14b928117..0b92775ae 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostAttachmentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingDirectCostAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAttachment? AccountingAttachment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostRequest.cs index 6e29a13db..42c7de2eb 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingDirectCostRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostResponse.cs index 756ad74b3..e3cedd9f8 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectCostResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingDirectCostResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingDirectCost? AccountingDirectCost { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.cs index 10ee23c3e..03304ab53 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingDirectIncomeAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentResponse.cs index a1212c62d..ea3685198 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeAttachmentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingDirectIncomeAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAttachment? AccountingAttachment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeRequest.cs index 20272b4bc..91644bffc 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingDirectIncomeRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeResponse.cs index 982fc862e..6661a58b4 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingDirectIncomeResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingDirectIncomeResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingDirectIncome? AccountingDirectIncome { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentRequest.cs index 50f5f0183..eac309425 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingInvoiceAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentResponse.cs index 506989ee5..64bdf474e 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceAttachmentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingInvoiceAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAttachment? AccountingAttachment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceRequest.cs index 9f5e0a5b4..ae90378ed 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingInvoiceRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceResponse.cs index b11daa392..5030c301a 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingInvoiceResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingInvoiceResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingInvoice? AccountingInvoice { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryRequest.cs index b1da26f72..41e3cd868 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingJournalEntryRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryResponse.cs index 2090886d1..91b3de48c 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingJournalEntryResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingJournalEntryResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingJournalEntry? AccountingJournalEntry { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingJournalRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingJournalRequest.cs index 69a13bff0..13b0ca2ab 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingJournalRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingJournalRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingJournalRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingJournalResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingJournalResponse.cs index a59fe5aca..29c7c85a9 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingJournalResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingJournalResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingJournalResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingJournal? AccountingJournal { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingPaymentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingPaymentRequest.cs index 0f3d081f4..5a1c8558c 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingPaymentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingPaymentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingPaymentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingPaymentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingPaymentResponse.cs index bdbd03e64..54fc68915 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingPaymentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingPaymentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingPaymentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingPayment? AccountingPayment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingProfileRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingProfileRequest.cs index 5049fd971..137abd03c 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingProfileRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingProfileRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingProfileRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingProfileResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingProfileResponse.cs index 3162db3c6..1f8fcc460 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingProfileResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingProfileResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingProfileResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCompanyInfo? AccountingCompanyInfo { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossRequest.cs index eb288fa76..0ef26069a 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingProfitAndLossRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossResponse.cs index 411dba1a2..8dcca9d37 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingProfitAndLossResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingProfitAndLossResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingProfitAndLossReport? AccountingProfitAndLossReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentRequest.cs index 6c4a1f53a..18b9b625e 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingSupplierAttachmentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentResponse.cs index dbbca9605..e9722e7e6 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierAttachmentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingSupplierAttachmentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAttachment? AccountingAttachment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierRequest.cs index f75aa3f18..a2f2eb75b 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingSupplierRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierResponse.cs index e35e479e4..13374b2d0 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingSupplierResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingSupplierResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingSupplierResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingSupplier? AccountingSupplier { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingTransferRequest.cs b/lending/Codat/Lending/Models/Requests/GetAccountingTransferRequest.cs index 1407ea13f..67eb2e995 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingTransferRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingTransferRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetAccountingTransferRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetAccountingTransferResponse.cs b/lending/Codat/Lending/Models/Requests/GetAccountingTransferResponse.cs index 505012219..8687658e1 100644 --- a/lending/Codat/Lending/Models/Requests/GetAccountingTransferResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetAccountingTransferResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetAccountingTransferResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingTransfer? AccountingTransfer { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetBankAccountMappingRequest.cs b/lending/Codat/Lending/Models/Requests/GetBankAccountMappingRequest.cs index c8815d030..2c5b8ab7b 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankAccountMappingRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankAccountMappingRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetBankAccountMappingRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetBankAccountMappingResponse.cs b/lending/Codat/Lending/Models/Requests/GetBankAccountMappingResponse.cs index ff194b744..21d83e009 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankAccountMappingResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankAccountMappingResponse.cs @@ -14,27 +14,26 @@ namespace Codat.Lending.Models.Requests using System; using System.Collections.Generic; using System.Net.Http; - + public class GetBankAccountMappingResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public List? BankFeedMappings { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationRequest.cs b/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationRequest.cs index 999eef2be..0d90e62d0 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetBankStatementUploadConfigurationRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationResponse.cs b/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationResponse.cs index 5438da32f..9d8bacbb8 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankStatementUploadConfigurationResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetBankStatementUploadConfigurationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankStatementUploadConfiguration? BankStatementUploadConfiguration { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetBankingAccountRequest.cs b/lending/Codat/Lending/Models/Requests/GetBankingAccountRequest.cs index 2ce057064..206553f3f 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankingAccountRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankingAccountRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetBankingAccountRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetBankingAccountResponse.cs b/lending/Codat/Lending/Models/Requests/GetBankingAccountResponse.cs index 83b421c97..ad1d75e15 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankingAccountResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankingAccountResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetBankingAccountResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingAccount? BankingAccount { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryRequest.cs b/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryRequest.cs index 79b9d05cc..7068ff364 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetBankingTransactionCategoryRequest { - /// /// Unique identifier for a company. /// @@ -27,7 +26,7 @@ public class GetBankingTransactionCategoryRequest public string ConnectionId { get; set; } = default!; /// - /// The unique identifier for a banking transaction category + /// The unique identifier for a banking transaction category. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionCategoryId")] public string TransactionCategoryId { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryResponse.cs b/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryResponse.cs index 31c9e9965..207839225 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankingTransactionCategoryResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetBankingTransactionCategoryResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingTransactionCategory? BankingTransactionCategory { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetBankingTransactionRequest.cs b/lending/Codat/Lending/Models/Requests/GetBankingTransactionRequest.cs index ece935912..435a9cea1 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankingTransactionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankingTransactionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetBankingTransactionRequest { - /// /// Unique identifier for a company. /// @@ -27,7 +26,7 @@ public class GetBankingTransactionRequest public string ConnectionId { get; set; } = default!; /// - /// The unique identifier for a transaction + /// The unique identifier for a transaction. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=transactionId")] public string TransactionId { get; set; } = default!; diff --git a/lending/Codat/Lending/Models/Requests/GetBankingTransactionResponse.cs b/lending/Codat/Lending/Models/Requests/GetBankingTransactionResponse.cs index 23521a4bc..1c9e44671 100644 --- a/lending/Codat/Lending/Models/Requests/GetBankingTransactionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetBankingTransactionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetBankingTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingTransaction? BankingTransaction { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementRequest.cs b/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementRequest.cs index b6b06b092..ecb453456 100644 --- a/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCategorizedBalanceSheetStatementRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementResponse.cs b/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementResponse.cs index ebcdec5db..f614834fc 100644 --- a/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCategorizedBalanceSheetStatementResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCategorizedBalanceSheetStatementResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public EnhancedFinancialReport? EnhancedFinancialReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementRequest.cs b/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementRequest.cs index c521af4eb..516c63023 100644 --- a/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCategorizedBankStatementRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementResponse.cs b/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementResponse.cs index d0bc82c7a..2cfe39511 100644 --- a/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCategorizedBankStatementResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCategorizedBankStatementResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public EnhancedCashFlowTransactions? EnhancedCashFlowTransactions { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementRequest.cs b/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementRequest.cs index 7ea40e90f..cfa00b3d9 100644 --- a/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCategorizedProfitAndLossStatementRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementResponse.cs b/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementResponse.cs index af7cb956d..64e360d67 100644 --- a/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCategorizedProfitAndLossStatementResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCategorizedProfitAndLossStatementResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public EnhancedFinancialReport? EnhancedFinancialReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRequest.cs index 513b89f51..3920a225f 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceCustomerRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerResponse.cs index 6cc91fcc6..cfc4cead7 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceCustomerResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceCustomer? CommerceCustomer { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsRequest.cs index fc944c476..627ae6291 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetCommerceCustomerRetentionMetricsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsResponse.cs index 14b15e52c..57b2fdcb3 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceCustomerRetentionMetricsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceCustomerRetentionMetricsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceReport? CommerceReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceDisputeRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceDisputeRequest.cs index d479e3520..cbd562c6d 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceDisputeRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceDisputeRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceDisputeRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceDisputeResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceDisputeResponse.cs index a4a9d69d2..3fc850304 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceDisputeResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceDisputeResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceDisputeResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceDispute? CommerceDispute { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsRequest.cs index 27aa75016..246e08c2a 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetCommerceLifetimeValueMetricsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsResponse.cs index 973a1e06c..f8d2f3df6 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceLifetimeValueMetricsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceLifetimeValueMetricsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceReport? CommerceReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceLocationRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceLocationRequest.cs index 1df2428ef..04bdf4097 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceLocationRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceLocationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceLocationRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceLocationResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceLocationResponse.cs index d3fbe7715..0db469f54 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceLocationResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceLocationResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceLocationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceLocation? CommerceLocation { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceOrderRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceOrderRequest.cs index 37d39e516..8833964cf 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceOrderRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceOrderRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceOrderRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceOrderResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceOrderResponse.cs index 351242b1a..8cd8bb79b 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceOrderResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceOrderResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceOrderResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceOrder? CommerceOrder { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportRequest.cs index a572e898a..704276a26 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetCommerceOrdersReportRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportResponse.cs index 30d709e7e..8667cca89 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceOrdersReportResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceOrdersReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceReport? CommerceReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodRequest.cs index 05a6cc8c8..d78d98cd3 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommercePaymentMethodRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodResponse.cs index 76757e40e..ff7769843 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommercePaymentMethodResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommercePaymentMethodResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommercePaymentMethod? CommercePaymentMethod { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommercePaymentRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommercePaymentRequest.cs index 02e99d420..ed38370f4 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommercePaymentRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommercePaymentRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommercePaymentRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommercePaymentResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommercePaymentResponse.cs index 14c2dcc01..f6bde4081 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommercePaymentResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommercePaymentResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommercePaymentResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommercePayment? CommercePayment { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryRequest.cs index 3020bf727..d9584dfdb 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceProductCategoryRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryResponse.cs index 446d6d69e..1f48b6e1e 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceProductCategoryResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceProductCategoryResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceProductCategory? CommerceProductCategory { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceProductRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceProductRequest.cs index 9cd6da223..b8b2c3c89 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceProductRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceProductRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceProductRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceProductResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceProductResponse.cs index ca60d73fd..c31b9ac70 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceProductResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceProductResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceProductResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceProduct? CommerceProduct { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceProfileRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceProfileRequest.cs index aeb128f46..4f73fc9d9 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceProfileRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceProfileRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceProfileRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceProfileResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceProfileResponse.cs index 80bae976e..75b86eec0 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceProfileResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceProfileResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceProfileResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceCompanyInfo? CommerceCompanyInfo { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportRequest.cs index 46edd3088..351a5cf3f 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetCommerceRefundsReportRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportResponse.cs index 9ad5f6958..02ced4dd2 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceRefundsReportResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceRefundsReportResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceReport? CommerceReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsRequest.cs index c5bb9c78a..fe0c690ae 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetCommerceRevenueMetricsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsResponse.cs index e6dd1a6d2..e8174e193 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceRevenueMetricsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceRevenueMetricsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceReport? CommerceReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceTransactionRequest.cs b/lending/Codat/Lending/Models/Requests/GetCommerceTransactionRequest.cs index 8e92a153f..d8c927705 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceTransactionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceTransactionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCommerceTransactionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCommerceTransactionResponse.cs b/lending/Codat/Lending/Models/Requests/GetCommerceTransactionResponse.cs index 22dd01684..9e020a079 100644 --- a/lending/Codat/Lending/Models/Requests/GetCommerceTransactionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCommerceTransactionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCommerceTransactionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceTransaction? CommerceTransaction { get; set; } = null; } diff --git a/lending/Codat/Lending/Models/Requests/GetCompanyRequest.cs b/lending/Codat/Lending/Models/Requests/GetCompanyRequest.cs index 82d146722..3715070e4 100644 --- a/lending/Codat/Lending/Models/Requests/GetCompanyRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCompanyRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCompanyRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCompanyResponse.cs b/lending/Codat/Lending/Models/Requests/GetCompanyResponse.cs index a8a47b480..9a2367b3d 100644 --- a/lending/Codat/Lending/Models/Requests/GetCompanyResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCompanyResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetConnectionRequest.cs b/lending/Codat/Lending/Models/Requests/GetConnectionRequest.cs index 81c443874..69aaa7349 100644 --- a/lending/Codat/Lending/Models/Requests/GetConnectionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetConnectionRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetConnectionResponse.cs b/lending/Codat/Lending/Models/Requests/GetConnectionResponse.cs index 13f30f90b..d5861b3c8 100644 --- a/lending/Codat/Lending/Models/Requests/GetConnectionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetConnectionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Connection? Connection { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelRequest.cs index 3e9eed827..17795c331 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateBankTransactionsModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelResponse.cs index 707833476..a96e2c103 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateBankTransactionsModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateBankTransactionsModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelRequest.cs index 06df207dc..c3ea5e906 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateChartOfAccountsModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelResponse.cs index 5a6255703..3affd177b 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateChartOfAccountsModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateChartOfAccountsModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelRequest.cs index 9022a0172..3b727b1fd 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateDirectCostsModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelResponse.cs index 63d850ee6..cecf0582e 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateDirectCostsModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateDirectCostsModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateOperationRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateOperationRequest.cs index cecd2b2d1..ed5626ec6 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateOperationRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateOperationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateOperationRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateOperationResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateOperationResponse.cs index c697b56db..58c824b2f 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateOperationResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateOperationResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateOperationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOperation? PushOperation { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelRequest.cs index e7f8a85dd..70d588dbe 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreatePaymentModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelResponse.cs index e9a84d8a8..93844b957 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreatePaymentModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreatePaymentModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelRequest.cs index a6597a109..0731d0675 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateTransfersModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelResponse.cs index 11cfcf119..059313399 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateTransfersModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateTransfersModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelRequest.cs index 4a0221951..6fc614e7d 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateUpdateBankAccountsModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelResponse.cs index 0b4ab65b8..a26913692 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateUpdateBankAccountsModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateUpdateBankAccountsModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelRequest.cs b/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelRequest.cs index cd95cb2da..ce2e8206c 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetCreateUpdateSuppliersModelRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelResponse.cs b/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelResponse.cs index 77ef7e574..f80bf8c4e 100644 --- a/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetCreateUpdateSuppliersModelResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetCreateUpdateSuppliersModelResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOption? PushOption { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusRequest.cs b/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusRequest.cs index 6daccad1d..161aeac6c 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetDataIntegrityStatusRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusResponse.cs b/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusResponse.cs index 650c9f717..fff12c6cb 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataIntegrityStatusResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetDataIntegrityStatusResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public DataIntegrityStatuses? DataIntegrityStatuses { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesRequest.cs b/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesRequest.cs index e9f4da946..8dbbbacaf 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetDataIntegritySummariesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesResponse.cs b/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesResponse.cs index 903fc094d..35e0f882d 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataIntegritySummariesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetDataIntegritySummariesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public DataIntegritySummaries? DataIntegritySummaries { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetDataStatusDataStatuses.cs b/lending/Codat/Lending/Models/Requests/GetDataStatusDataStatuses.cs index 5d8a2af3e..0918ef6a9 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataStatusDataStatuses.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataStatusDataStatuses.cs @@ -12,267 +12,266 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + /// - /// OK + /// OK. /// public class GetDataStatusDataStatuses { - /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("accountTransactions")] public DataStatus? AccountTransactions { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("balanceSheet")] public DataStatus? BalanceSheet { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("bankAccounts")] public DataStatus? BankAccounts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("bankTransactions")] public DataStatus? BankTransactions { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("billCreditNotes")] public DataStatus? BillCreditNotes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("billPayments")] public DataStatus? BillPayments { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("bills")] public DataStatus? Bills { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("cashFlowStatement")] public DataStatus? CashFlowStatement { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("chartOfAccounts")] public DataStatus? ChartOfAccounts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("company")] public DataStatus? Company { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("creditNotes")] public DataStatus? CreditNotes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("customers")] public DataStatus? Customers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("directCosts")] public DataStatus? DirectCosts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("directIncomes")] public DataStatus? DirectIncomes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("invoices")] public DataStatus? Invoices { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("itemReceipts")] public DataStatus? ItemReceipts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("items")] public DataStatus? Items { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("journalEntries")] public DataStatus? JournalEntries { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("journals")] public DataStatus? Journals { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("paymentMethods")] public DataStatus? PaymentMethods { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("payments")] public DataStatus? Payments { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("profitAndLoss")] public DataStatus? ProfitAndLoss { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("purchaseOrders")] public DataStatus? PurchaseOrders { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("salesOrders")] public DataStatus? SalesOrders { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("suppliers")] public DataStatus? Suppliers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("taxRates")] public DataStatus? TaxRates { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("trackingCategories")] public DataStatus? TrackingCategories { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("transfers")] public DataStatus? Transfers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-accountBalances")] public DataStatus? BankingAccountBalances { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-accounts")] public DataStatus? BankingAccounts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-transactionCategories")] public DataStatus? BankingTransactionCategories { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("banking-transactions")] public DataStatus? BankingTransactions { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-companyInfo")] public DataStatus? CommerceCompanyInfo { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-customers")] public DataStatus? CommerceCustomers { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-disputes")] public DataStatus? CommerceDisputes { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-locations")] public DataStatus? CommerceLocations { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-orders")] public DataStatus? CommerceOrders { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-paymentMethods")] public DataStatus? CommercePaymentMethods { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-payments")] public DataStatus? CommercePayments { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-productCategories")] public DataStatus? CommerceProductCategories { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-products")] public DataStatus? CommerceProducts { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-taxComponents")] public DataStatus? CommerceTaxComponents { get; set; } /// - /// Describes the state of data in the Codat cache for a company and data type + /// Describes the state of data in the Codat cache for a company and data type. /// [JsonProperty("commerce-transactions")] public DataStatus? CommerceTransactions { get; set; } diff --git a/lending/Codat/Lending/Models/Requests/GetDataStatusRequest.cs b/lending/Codat/Lending/Models/Requests/GetDataStatusRequest.cs index 7fcc8cb1c..f3db4f313 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataStatusRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataStatusRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetDataStatusRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetDataStatusResponse.cs b/lending/Codat/Lending/Models/Requests/GetDataStatusResponse.cs index 9832e06cd..1e00a48ae 100644 --- a/lending/Codat/Lending/Models/Requests/GetDataStatusResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetDataStatusResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetDataStatusResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public GetDataStatusDataStatuses? DataStatuses { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusRequest.cs b/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusRequest.cs index 8da0fbfca..a26de164e 100644 --- a/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class GetExcelReportGenerationStatusRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusResponse.cs b/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusResponse.cs index 4584309ca..d9c4f74c6 100644 --- a/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetExcelReportGenerationStatusResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetExcelReportGenerationStatusResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public ExcelStatus? ExcelStatus { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetLoanSummaryQueryParamSourceType.cs b/lending/Codat/Lending/Models/Requests/GetLoanSummaryQueryParamSourceType.cs index a5d2dbd7c..5dd3ee6fc 100644 --- a/lending/Codat/Lending/Models/Requests/GetLoanSummaryQueryParamSourceType.cs +++ b/lending/Codat/Lending/Models/Requests/GetLoanSummaryQueryParamSourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Data source type. /// @@ -58,5 +58,4 @@ public static GetLoanSummaryQueryParamSourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum GetLoanSummaryQueryParamSourceType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Requests/GetLoanSummaryRequest.cs b/lending/Codat/Lending/Models/Requests/GetLoanSummaryRequest.cs index 7e7f00e2e..9c075a248 100644 --- a/lending/Codat/Lending/Models/Requests/GetLoanSummaryRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetLoanSummaryRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class GetLoanSummaryRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetLoanSummaryResponse.cs b/lending/Codat/Lending/Models/Requests/GetLoanSummaryResponse.cs index 1d24ffc47..2d24ff150 100644 --- a/lending/Codat/Lending/Models/Requests/GetLoanSummaryResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetLoanSummaryResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetLoanSummaryResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public LoanSummary? LoanSummary { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/GetPullOperationRequest.cs b/lending/Codat/Lending/Models/Requests/GetPullOperationRequest.cs index bb45323df..7f3c675a4 100644 --- a/lending/Codat/Lending/Models/Requests/GetPullOperationRequest.cs +++ b/lending/Codat/Lending/Models/Requests/GetPullOperationRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class GetPullOperationRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/GetPullOperationResponse.cs b/lending/Codat/Lending/Models/Requests/GetPullOperationResponse.cs index 9f46e4e33..0f42b0e54 100644 --- a/lending/Codat/Lending/Models/Requests/GetPullOperationResponse.cs +++ b/lending/Codat/Lending/Models/Requests/GetPullOperationResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class GetPullOperationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PullOperation? PullOperation { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableRequest.cs b/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableRequest.cs index de4dcc41a..4a8982cc9 100644 --- a/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableRequest.cs +++ b/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class IsAgedCreditorsReportAvailableRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableResponse.cs b/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableResponse.cs index 83e458d56..d50e2e459 100644 --- a/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableResponse.cs +++ b/lending/Codat/Lending/Models/Requests/IsAgedCreditorsReportAvailableResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class IsAgedCreditorsReportAvailableResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public bool? Boolean { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableRequest.cs b/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableRequest.cs index 224533f65..f48514267 100644 --- a/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableRequest.cs +++ b/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class IsAgedDebtorsReportAvailableRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableResponse.cs b/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableResponse.cs index 832e2c66d..fb3d0b482 100644 --- a/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableResponse.cs +++ b/lending/Codat/Lending/Models/Requests/IsAgedDebtorsReportAvailableResponse.cs @@ -12,27 +12,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class IsAgedDebtorsReportAvailableResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public bool? Boolean { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsRequest.cs index 16ee40cd4..2f9174125 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingAccountTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsResponse.cs index 820d04f87..052a927ca 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingAccountTransactionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingAccountTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAccountTransactions? AccountingAccountTransactions { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingAccountsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingAccountsRequest.cs index 707990816..8b4195789 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingAccountsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingAccountsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingAccountsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingAccountsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingAccountsResponse.cs index 9448f23c9..4eab5d69f 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingAccountsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingAccountsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingAccountsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingAccounts? AccountingAccounts { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsRequest.cs index 2398446b8..18e50243c 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingBankAccountTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsResponse.cs index df856fdba..51b726a1f 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountTransactionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingBankAccountTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBankTransactions? AccountingBankTransactions { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsRequest.cs index b6fe82c95..e1e30b6e1 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingBankAccountsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsResponse.cs index 02ba0519c..a27c83be2 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBankAccountsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingBankAccountsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBankAccounts? AccountingBankAccounts { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsRequest.cs index e2cde1882..7f4256429 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingBillAttachmentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsResponse.cs index 123ffc331..4617fbce3 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillAttachmentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingBillAttachmentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Attachments? Attachments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesRequest.cs index 7635bf13b..e8107c4a6 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingBillCreditNotesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesResponse.cs index c9a38f473..281ee47ec 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillCreditNotesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingBillCreditNotesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBillCreditNotes? AccountingBillCreditNotes { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsRequest.cs index 5ee232b75..3fae78f40 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingBillPaymentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsResponse.cs index 3a14f64ca..2753d4077 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillPaymentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingBillPaymentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBillPayments? AccountingBillPayments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillsRequest.cs index 22a303263..3276e589f 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingBillsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingBillsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingBillsResponse.cs index d8ddad42c..21ecae63d 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingBillsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingBillsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingBillsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingBills? AccountingBills { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesRequest.cs index 2e6fc0d3b..b104a334a 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingCreditNotesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesResponse.cs index c45b66053..4b1f89c30 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingCreditNotesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingCreditNotesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCreditNotes? AccountingCreditNotes { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsRequest.cs index dae2eab6d..c88101cad 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingCustomerAttachmentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsResponse.cs index f2a8633f7..6e79b0b3c 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingCustomerAttachmentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingCustomerAttachmentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Attachments? Attachments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingCustomersRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingCustomersRequest.cs index a6e98a783..5705268b2 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingCustomersRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingCustomersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingCustomersRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingCustomersResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingCustomersResponse.cs index d129c2aec..26b8526bd 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingCustomersResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingCustomersResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingCustomersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingCustomers? AccountingCustomers { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsRequest.cs index 042b7c0e0..0c01e27a9 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingDirectCostAttachmentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsResponse.cs index f62942f97..46a21b1b0 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostAttachmentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingDirectCostAttachmentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Attachments? Attachments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsRequest.cs index b1182b55a..14ba0386e 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingDirectCostsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsResponse.cs index c3b5eede7..c70dd00fb 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectCostsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingDirectCostsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingDirectCosts? AccountingDirectCosts { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.cs index 782d12f38..0759d718d 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingDirectIncomeAttachmentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsResponse.cs index 4069a0a2a..5e8656f2d 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomeAttachmentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingDirectIncomeAttachmentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Attachments? Attachments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesRequest.cs index 1d42ff230..946a22671 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingDirectIncomesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesResponse.cs index c5df26329..5f3e985ac 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingDirectIncomesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingDirectIncomesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingDirectIncomes? AccountingDirectIncomes { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsRequest.cs index cb2163ad7..ce52c0d2c 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingInvoiceAttachmentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsResponse.cs index cc932781d..ae2aa1008 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingInvoiceAttachmentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingInvoiceAttachmentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Attachments? Attachments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesRequest.cs index c2ccb6359..ad53228b7 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingInvoicesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesResponse.cs index 5b4d6910a..10131f1a3 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingInvoicesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingInvoicesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingInvoices? AccountingInvoices { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesRequest.cs index d902760bf..535a9e129 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingJournalEntriesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesResponse.cs index 879e3b218..fc1ca7b2b 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingJournalEntriesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingJournalEntriesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingJournalEntries? AccountingJournalEntries { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingJournalsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingJournalsRequest.cs index 256322520..e95e6262e 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingJournalsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingJournalsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingJournalsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingJournalsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingJournalsResponse.cs index 630f9a4e9..94eb7bbc5 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingJournalsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingJournalsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingJournalsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingJournals? AccountingJournals { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsRequest.cs index e137e5be7..41f18f12c 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingPaymentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsResponse.cs index 30c7ad35f..efea81e91 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingPaymentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingPaymentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingPayments? AccountingPayments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsRequest.cs index 2a8d28764..309963c3a 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingSupplierAttachmentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsResponse.cs index 18a4c9a3c..d5c139ee3 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingSupplierAttachmentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingSupplierAttachmentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Attachments? Attachments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersRequest.cs index 22713cb7d..fe88ceb09 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingSuppliersRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersResponse.cs index 249a7adc1..8ea47a642 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingSuppliersResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingSuppliersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingSuppliers? AccountingSuppliers { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingTransfersRequest.cs b/lending/Codat/Lending/Models/Requests/ListAccountingTransfersRequest.cs index 32b1cf1f3..b822b0912 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingTransfersRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingTransfersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListAccountingTransfersRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListAccountingTransfersResponse.cs b/lending/Codat/Lending/Models/Requests/ListAccountingTransfersResponse.cs index 41cf99505..53f6d04c9 100644 --- a/lending/Codat/Lending/Models/Requests/ListAccountingTransfersResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListAccountingTransfersResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListAccountingTransfersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public AccountingTransfers? AccountingTransfers { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesRequest.cs b/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesRequest.cs index 1e2b745d1..44e07fc91 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListBankingAccountBalancesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesResponse.cs b/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesResponse.cs index bf152af95..c18721ae8 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingAccountBalancesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListBankingAccountBalancesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingAccountBalances? BankingAccountBalances { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListBankingAccountsRequest.cs b/lending/Codat/Lending/Models/Requests/ListBankingAccountsRequest.cs index 0efdccd58..206dbed26 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingAccountsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingAccountsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListBankingAccountsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListBankingAccountsResponse.cs b/lending/Codat/Lending/Models/Requests/ListBankingAccountsResponse.cs index 416add0d2..18da5e98b 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingAccountsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingAccountsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListBankingAccountsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingAccounts? BankingAccounts { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesRequest.cs b/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesRequest.cs index 5b820345d..305fc2674 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListBankingTransactionCategoriesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesResponse.cs b/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesResponse.cs index 1a6e2a129..62b0d685e 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingTransactionCategoriesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListBankingTransactionCategoriesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingTransactionCategories? BankingTransactionCategories { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListBankingTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/ListBankingTransactionsRequest.cs index ee7cf77a7..ed8a8898a 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingTransactionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListBankingTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListBankingTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/ListBankingTransactionsResponse.cs index 9b4e8ceb1..8f1896b0a 100644 --- a/lending/Codat/Lending/Models/Requests/ListBankingTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListBankingTransactionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListBankingTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankingTransactions? BankingTransactions { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceCustomersRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceCustomersRequest.cs index 0eb13d5ff..d01fae726 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceCustomersRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceCustomersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceCustomersRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceCustomersResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceCustomersResponse.cs index 0e7a3eb78..1d85fa736 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceCustomersResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceCustomersResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceCustomersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceCustomers? CommerceCustomers { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceDisputesRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceDisputesRequest.cs index a8be235f7..494531183 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceDisputesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceDisputesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceDisputesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceDisputesResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceDisputesResponse.cs index d6ef9151c..05b596a8c 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceDisputesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceDisputesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceDisputesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceDisputes? CommerceDisputes { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceLocationsRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceLocationsRequest.cs index 39b5cbba2..8af79666c 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceLocationsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceLocationsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceLocationsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceLocationsResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceLocationsResponse.cs index c9d623410..42762f335 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceLocationsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceLocationsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceLocationsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceLocations? CommerceLocations { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceOrdersRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceOrdersRequest.cs index 185e3ae03..95bccfd52 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceOrdersRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceOrdersRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceOrdersRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceOrdersResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceOrdersResponse.cs index 6f09159e2..03d3cff19 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceOrdersResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceOrdersResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceOrdersResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceOrders? CommerceOrders { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsRequest.cs index 507734f92..bbe729041 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommercePaymentMethodsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsResponse.cs index 7e760ed27..4fc5ec9c3 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommercePaymentMethodsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommercePaymentMethodsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommercePaymentMethods? CommercePaymentMethods { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommercePaymentsRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommercePaymentsRequest.cs index 6f998e701..c5ccb51a9 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommercePaymentsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommercePaymentsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommercePaymentsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommercePaymentsResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommercePaymentsResponse.cs index 67f23785c..7b5b763b3 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommercePaymentsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommercePaymentsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommercePaymentsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommercePayments? CommercePayments { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesRequest.cs index 4b1687cc7..9e74a6b7a 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceProductCategoriesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesResponse.cs index 9ac0d78f1..160d6f555 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceProductCategoriesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceProductCategoriesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceProductCategories? CommerceProductCategories { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceProductsRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceProductsRequest.cs index 45de7794a..b8c8446e5 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceProductsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceProductsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceProductsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceProductsResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceProductsResponse.cs index d8f5bdf90..739e6c6a4 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceProductsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceProductsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceProductsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceProducts? CommerceProducts { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsRequest.cs index 2e2591cf5..87d45d86a 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCommerceTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsResponse.cs index 5a4edbddf..514ed015b 100644 --- a/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCommerceTransactionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCommerceTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public CommerceTransactions? CommerceTransactions { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCompaniesRequest.cs b/lending/Codat/Lending/Models/Requests/ListCompaniesRequest.cs index d2ede601f..65e0db473 100644 --- a/lending/Codat/Lending/Models/Requests/ListCompaniesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCompaniesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCompaniesRequest { - /// /// Page number. Read more. /// @@ -39,7 +38,7 @@ public class ListCompaniesRequest public string? OrderBy { get; set; } /// - /// Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with Codat’s query language. + /// Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with Codat’s query language. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=tags")] public string? Tags { get; set; } diff --git a/lending/Codat/Lending/Models/Requests/ListCompaniesResponse.cs b/lending/Codat/Lending/Models/Requests/ListCompaniesResponse.cs index fe6cdb6bd..c82008a58 100644 --- a/lending/Codat/Lending/Models/Requests/ListCompaniesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCompaniesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCompaniesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Models.Components.Companies? Companies { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListConnectionsRequest.cs b/lending/Codat/Lending/Models/Requests/ListConnectionsRequest.cs index f7df8f9c2..db9d9fcd3 100644 --- a/lending/Codat/Lending/Models/Requests/ListConnectionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListConnectionsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListConnectionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListConnectionsResponse.cs b/lending/Codat/Lending/Models/Requests/ListConnectionsResponse.cs index 62834e6de..9294061d8 100644 --- a/lending/Codat/Lending/Models/Requests/ListConnectionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListConnectionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListConnectionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Models.Components.Connections? Connections { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListCreateOperationsRequest.cs b/lending/Codat/Lending/Models/Requests/ListCreateOperationsRequest.cs index fc28646dd..9824d586f 100644 --- a/lending/Codat/Lending/Models/Requests/ListCreateOperationsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListCreateOperationsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListCreateOperationsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListCreateOperationsResponse.cs b/lending/Codat/Lending/Models/Requests/ListCreateOperationsResponse.cs index 96991c384..adbc29882 100644 --- a/lending/Codat/Lending/Models/Requests/ListCreateOperationsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListCreateOperationsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListCreateOperationsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PushOperations? PushOperations { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsRequest.cs b/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsRequest.cs index a76c7d110..2d605bd66 100644 --- a/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class ListDataIntegrityDetailsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsResponse.cs b/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsResponse.cs index 40ddedef9..23937d02c 100644 --- a/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListDataIntegrityDetailsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListDataIntegrityDetailsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public DataIntegrityDetails? DataIntegrityDetails { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListFilesRequest.cs b/lending/Codat/Lending/Models/Requests/ListFilesRequest.cs index a90146a4d..db75efc99 100644 --- a/lending/Codat/Lending/Models/Requests/ListFilesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListFilesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListFilesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListFilesResponse.cs b/lending/Codat/Lending/Models/Requests/ListFilesResponse.cs index f86341fa4..6966a1ea5 100644 --- a/lending/Codat/Lending/Models/Requests/ListFilesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListFilesResponse.cs @@ -14,27 +14,26 @@ namespace Codat.Lending.Models.Requests using System; using System.Collections.Generic; using System.Net.Http; - + public class ListFilesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public List? Files { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListLoanTransactionsRequest.cs b/lending/Codat/Lending/Models/Requests/ListLoanTransactionsRequest.cs index 0e6327775..b03596cdd 100644 --- a/lending/Codat/Lending/Models/Requests/ListLoanTransactionsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListLoanTransactionsRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class ListLoanTransactionsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListLoanTransactionsResponse.cs b/lending/Codat/Lending/Models/Requests/ListLoanTransactionsResponse.cs index fe901b404..9dcf9c184 100644 --- a/lending/Codat/Lending/Models/Requests/ListLoanTransactionsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListLoanTransactionsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListLoanTransactionsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public LoanTransactions? LoanTransactions { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListPullOperationsRequest.cs b/lending/Codat/Lending/Models/Requests/ListPullOperationsRequest.cs index 391a3d386..307af1eb4 100644 --- a/lending/Codat/Lending/Models/Requests/ListPullOperationsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListPullOperationsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListPullOperationsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListPullOperationsResponse.cs b/lending/Codat/Lending/Models/Requests/ListPullOperationsResponse.cs index e82458e9e..97a85adcc 100644 --- a/lending/Codat/Lending/Models/Requests/ListPullOperationsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListPullOperationsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListPullOperationsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Models.Components.PullOperations? PullOperations { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesRequest.cs b/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesRequest.cs index f896cbec3..4aed10639 100644 --- a/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListReconciledInvoicesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesResponse.cs b/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesResponse.cs index faf56a007..fa29b6eb1 100644 --- a/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListReconciledInvoicesResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListReconciledInvoicesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public EnhancedInvoicesReport? EnhancedInvoicesReport { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ListReportsRequest.cs b/lending/Codat/Lending/Models/Requests/ListReportsRequest.cs index b4dc5a1cc..8ce64c338 100644 --- a/lending/Codat/Lending/Models/Requests/ListReportsRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ListReportsRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class ListReportsRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ListReportsResponse.cs b/lending/Codat/Lending/Models/Requests/ListReportsResponse.cs index ceee4c11a..d9173c2f7 100644 --- a/lending/Codat/Lending/Models/Requests/ListReportsResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ListReportsResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ListReportsResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public Models.Components.Reports? Reports { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/QueryParamSourceType.cs b/lending/Codat/Lending/Models/Requests/QueryParamSourceType.cs index 270d092eb..d10c0607f 100644 --- a/lending/Codat/Lending/Models/Requests/QueryParamSourceType.cs +++ b/lending/Codat/Lending/Models/Requests/QueryParamSourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Data source type. /// @@ -58,5 +58,4 @@ public static QueryParamSourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum QueryParamSourceType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesRequest.cs b/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesRequest.cs index 6773864d0..4b5ab834b 100644 --- a/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesRequest.cs @@ -10,10 +10,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Utils; - + public class RefreshAllDataTypesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesResponse.cs b/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesResponse.cs index 28a20ca3f..5a2bdf08c 100644 --- a/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/RefreshAllDataTypesResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class RefreshAllDataTypesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/RefreshDataTypeRequest.cs b/lending/Codat/Lending/Models/Requests/RefreshDataTypeRequest.cs index 1746edd68..18d89afda 100644 --- a/lending/Codat/Lending/Models/Requests/RefreshDataTypeRequest.cs +++ b/lending/Codat/Lending/Models/Requests/RefreshDataTypeRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class RefreshDataTypeRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/RefreshDataTypeResponse.cs b/lending/Codat/Lending/Models/Requests/RefreshDataTypeResponse.cs index e2e90866c..eec41a34f 100644 --- a/lending/Codat/Lending/Models/Requests/RefreshDataTypeResponse.cs +++ b/lending/Codat/Lending/Models/Requests/RefreshDataTypeResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class RefreshDataTypeResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public PullOperation? PullOperation { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/ReplaceCompanyRequest.cs b/lending/Codat/Lending/Models/Requests/ReplaceCompanyRequest.cs index 853c3ccf8..cd5a55fca 100644 --- a/lending/Codat/Lending/Models/Requests/ReplaceCompanyRequest.cs +++ b/lending/Codat/Lending/Models/Requests/ReplaceCompanyRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class ReplaceCompanyRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/ReplaceCompanyResponse.cs b/lending/Codat/Lending/Models/Requests/ReplaceCompanyResponse.cs index 7a9e9db84..ba0d98445 100644 --- a/lending/Codat/Lending/Models/Requests/ReplaceCompanyResponse.cs +++ b/lending/Codat/Lending/Models/Requests/ReplaceCompanyResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ReplaceCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationRequest.cs b/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationRequest.cs index 0cd4c12c2..cbd9f6bb9 100644 --- a/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationRequest.cs +++ b/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class SetBankStatementUploadConfigurationRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationResponse.cs b/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationResponse.cs index 1705fd318..7df947fba 100644 --- a/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationResponse.cs +++ b/lending/Codat/Lending/Models/Requests/SetBankStatementUploadConfigurationResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class SetBankStatementUploadConfigurationResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public BankStatementUploadConfiguration? BankStatementUploadConfiguration { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/SourceType.cs b/lending/Codat/Lending/Models/Requests/SourceType.cs index 5824b9982..961b2ac8e 100644 --- a/lending/Codat/Lending/Models/Requests/SourceType.cs +++ b/lending/Codat/Lending/Models/Requests/SourceType.cs @@ -12,7 +12,7 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using Newtonsoft.Json; using System; - + /// /// Data source type. /// @@ -58,5 +58,4 @@ public static SourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceType"); } } - } \ No newline at end of file diff --git a/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionRequest.cs b/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionRequest.cs index 900372251..14215cf8e 100644 --- a/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class StartBankStatementUploadSessionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionResponse.cs b/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionResponse.cs index c73fa52ba..8c08218dd 100644 --- a/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/StartBankStatementUploadSessionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class StartBankStatementUploadSessionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// Success + /// Success. /// public PullOperation? PullOperation { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/UnlinkConnectionRequest.cs b/lending/Codat/Lending/Models/Requests/UnlinkConnectionRequest.cs index e7726440b..362c1a90e 100644 --- a/lending/Codat/Lending/Models/Requests/UnlinkConnectionRequest.cs +++ b/lending/Codat/Lending/Models/Requests/UnlinkConnectionRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class UnlinkConnectionRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/UnlinkConnectionResponse.cs b/lending/Codat/Lending/Models/Requests/UnlinkConnectionResponse.cs index 17fe76af5..6c5ab4440 100644 --- a/lending/Codat/Lending/Models/Requests/UnlinkConnectionResponse.cs +++ b/lending/Codat/Lending/Models/Requests/UnlinkConnectionResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class UnlinkConnectionResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Connection? Connection { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/UnlinkConnectionUpdateConnection.cs b/lending/Codat/Lending/Models/Requests/UnlinkConnectionUpdateConnection.cs index 15fe5fc51..62bba018f 100644 --- a/lending/Codat/Lending/Models/Requests/UnlinkConnectionUpdateConnection.cs +++ b/lending/Codat/Lending/Models/Requests/UnlinkConnectionUpdateConnection.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class UnlinkConnectionUpdateConnection { - /// /// The current authorization status of the data connection. /// diff --git a/lending/Codat/Lending/Models/Requests/UpdateCompanyRequest.cs b/lending/Codat/Lending/Models/Requests/UpdateCompanyRequest.cs index cb74612d6..fef641c22 100644 --- a/lending/Codat/Lending/Models/Requests/UpdateCompanyRequest.cs +++ b/lending/Codat/Lending/Models/Requests/UpdateCompanyRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class UpdateCompanyRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/UpdateCompanyResponse.cs b/lending/Codat/Lending/Models/Requests/UpdateCompanyResponse.cs index ba5f23b6e..97719fee3 100644 --- a/lending/Codat/Lending/Models/Requests/UpdateCompanyResponse.cs +++ b/lending/Codat/Lending/Models/Requests/UpdateCompanyResponse.cs @@ -13,27 +13,26 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class UpdateCompanyResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; /// - /// OK + /// OK. /// public Company? Company { get; set; } } diff --git a/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequest.cs b/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequest.cs index 41c75ff90..8c07314fc 100644 --- a/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequest.cs +++ b/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequest.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Models.Components; using Codat.Lending.Models.Requests; using Codat.Lending.Utils; - + public class UploadBankStatementDataRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequestBody.cs b/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequestBody.cs index de882e742..37b0c75f9 100644 --- a/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequestBody.cs +++ b/lending/Codat/Lending/Models/Requests/UploadBankStatementDataRequestBody.cs @@ -55,7 +55,6 @@ public override int GetHashCode() } } - [JsonConverter(typeof(UploadBankStatementDataRequestBody.UploadBankStatementDataRequestBodyConverter))] public class UploadBankStatementDataRequestBody { diff --git a/lending/Codat/Lending/Models/Requests/UploadBankStatementDataResponse.cs b/lending/Codat/Lending/Models/Requests/UploadBankStatementDataResponse.cs index 89748b03b..b3432633c 100644 --- a/lending/Codat/Lending/Models/Requests/UploadBankStatementDataResponse.cs +++ b/lending/Codat/Lending/Models/Requests/UploadBankStatementDataResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class UploadBankStatementDataResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Requests/UploadFilesRequest.cs b/lending/Codat/Lending/Models/Requests/UploadFilesRequest.cs index bfddd7873..a7a60c3ca 100644 --- a/lending/Codat/Lending/Models/Requests/UploadFilesRequest.cs +++ b/lending/Codat/Lending/Models/Requests/UploadFilesRequest.cs @@ -11,10 +11,9 @@ namespace Codat.Lending.Models.Requests { using Codat.Lending.Models.Components; using Codat.Lending.Utils; - + public class UploadFilesRequest { - /// /// Unique identifier for a company. /// diff --git a/lending/Codat/Lending/Models/Requests/UploadFilesResponse.cs b/lending/Codat/Lending/Models/Requests/UploadFilesResponse.cs index 755abd22a..0efadefa8 100644 --- a/lending/Codat/Lending/Models/Requests/UploadFilesResponse.cs +++ b/lending/Codat/Lending/Models/Requests/UploadFilesResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Requests using Codat.Lending.Utils; using System; using System.Net.Http; - + public class UploadFilesResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/AccountCategoriesUpdatedResponse.cs b/lending/Codat/Lending/Models/Webhooks/AccountCategoriesUpdatedResponse.cs index d64fe5e20..8f26c9161 100644 --- a/lending/Codat/Lending/Models/Webhooks/AccountCategoriesUpdatedResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/AccountCategoriesUpdatedResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class AccountCategoriesUpdatedResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/ClientRateLimitReachedResponse.cs b/lending/Codat/Lending/Models/Webhooks/ClientRateLimitReachedResponse.cs index c5c680f2f..b7c471c4c 100644 --- a/lending/Codat/Lending/Models/Webhooks/ClientRateLimitReachedResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/ClientRateLimitReachedResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ClientRateLimitReachedResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/ClientRateLimitResetResponse.cs b/lending/Codat/Lending/Models/Webhooks/ClientRateLimitResetResponse.cs index efeb8ca55..5812630ac 100644 --- a/lending/Codat/Lending/Models/Webhooks/ClientRateLimitResetResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/ClientRateLimitResetResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ClientRateLimitResetResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateSuccessfulResponse.cs b/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateSuccessfulResponse.cs index fdcf60bf8..9b58daf78 100644 --- a/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateSuccessfulResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateSuccessfulResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ReportsCategorizedBankStatementGenerateSuccessfulResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateUnsuccessfulResponse.cs b/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateUnsuccessfulResponse.cs index 1efbe31b1..b25f66f26 100644 --- a/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateUnsuccessfulResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/ReportsCategorizedBankStatementGenerateUnsuccessfulResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ReportsCategorizedBankStatementGenerateUnsuccessfulResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.cs b/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.cs index 7451b6202..cf35b456d 100644 --- a/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.cs +++ b/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.cs @@ -12,10 +12,9 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Models.Components; using Codat.Lending.Utils; using Newtonsoft.Json; - + public class ReportsCreditModelGenerateSuccessfulReportGenerationWebhook { - /// /// Unique identifier of the event. /// @@ -29,9 +28,7 @@ public class ReportsCreditModelGenerateSuccessfulReportGenerationWebhook public string? EventType { get; set; } /// - /// 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:
- /// - /// + /// 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
@@ -50,7 +47,6 @@ public class ReportsCreditModelGenerateSuccessfulReportGenerationWebhook /// >
/// > 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. - ///
///
[JsonProperty("generatedDate")] public string? GeneratedDate { get; set; } diff --git a/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulResponse.cs b/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulResponse.cs index bcf15c9bb..58c4694a7 100644 --- a/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateSuccessfulResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ReportsCreditModelGenerateSuccessfulResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateUnsuccessfulResponse.cs b/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateUnsuccessfulResponse.cs index 7ca6082a5..de051e545 100644 --- a/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateUnsuccessfulResponse.cs +++ b/lending/Codat/Lending/Models/Webhooks/ReportsCreditModelGenerateUnsuccessfulResponse.cs @@ -12,22 +12,21 @@ namespace Codat.Lending.Models.Webhooks using Codat.Lending.Utils; using System; using System.Net.Http; - + public class ReportsCreditModelGenerateUnsuccessfulResponse { - /// - /// HTTP response content type for this operation + /// HTTP response content type for this operation. /// public string? ContentType { get; set; } = default!; /// - /// HTTP response status code for this operation + /// HTTP response status code for this operation. /// public int StatusCode { get; set; } = default!; /// - /// Raw HTTP response; suitable for custom response parsing + /// Raw HTTP response; suitable for custom response parsing. /// public HttpResponseMessage RawResponse { get; set; } = default!; } diff --git a/lending/Codat/Lending/Orders.cs b/lending/Codat/Lending/Orders.cs index 71a2acb06..60835c37b 100644 --- a/lending/Codat/Lending/Orders.cs +++ b/lending/Codat/Lending/Orders.cs @@ -24,51 +24,85 @@ namespace Codat.Lending public interface IOrders { - /// - /// List orders - /// + /// List orders. + /// /// - /// The *List orders* endpoint returns a list of orders for a given company's connection.
+ /// The *List orders* endpoint returns a list of orders for a given company's connection.
///
/// Orders contain the transaction details for all products sold by the company.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- ///
- Task ListAsync(ListCommerceOrdersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceOrdersRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get order - /// + /// Get order. + /// /// /// The *Get order* endpoint returns a single order for a given orderId.
///
/// Orders contain the transaction details for all products sold by the company.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- ///
- Task GetAsync(GetCommerceOrderRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetCommerceOrderRequest request, RetryConfig? retryConfig = null); } public class Orders: IOrders { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Orders(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceOrdersRequest request, RetryConfig? retryConfig = null) + /// + /// List orders. + /// + /// + /// The *List orders* endpoint returns a list of orders for a given company's connection.
+ ///
+ /// Orders contain the transaction details for all products sold by the company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceOrdersRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +162,7 @@ public async Task ListAsync(ListCommerceOrdersReques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +267,29 @@ public async Task ListAsync(ListCommerceOrdersReques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceOrderRequest request, RetryConfig? retryConfig = null) + + /// + /// Get order. + /// + /// + /// The *Get order* endpoint returns a single order for a given orderId.
+ ///
+ /// Orders contain the transaction details for all products sold by the company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceOrderRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +349,7 @@ public async Task GetAsync(GetCommerceOrderRequest req httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +453,6 @@ public async Task GetAsync(GetCommerceOrderRequest req throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/PaymentMethods.cs b/lending/Codat/Lending/PaymentMethods.cs index 1ae08a2ea..24e2ce2d3 100644 --- a/lending/Codat/Lending/PaymentMethods.cs +++ b/lending/Codat/Lending/PaymentMethods.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IPaymentMethods { - /// - /// List payment methods - /// + /// List payment methods. + /// /// - /// The *List payment methods* endpoint returns a list of payment methods for a given company's connection.
+ /// The *List payment methods* endpoint returns a list of payment methods for a given company's connection.
///
/// Payment methods represent the payment method(s) used to make payments.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommercePaymentMethodsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommercePaymentMethodsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get payment method - /// + /// Get payment method. + /// /// /// The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.
///
/// Payment methods represent the payment method(s) used to make payments.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommercePaymentMethodRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommercePaymentMethodRequest request, + RetryConfig? retryConfig = null + ); } public class PaymentMethods: IPaymentMethods { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public PaymentMethods(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommercePaymentMethodsRequest request, RetryConfig? retryConfig = null) + /// + /// List payment methods. + /// + /// + /// The *List payment methods* endpoint returns a list of payment methods for a given company's connection.
+ ///
+ /// Payment methods represent the payment method(s) used to make payments.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommercePaymentMethodsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommercePaym httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommercePaym throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommercePaymentMethodRequest request, RetryConfig? retryConfig = null) + + /// + /// Get payment method. + /// + /// + /// The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.
+ ///
+ /// Payment methods represent the payment method(s) used to make payments.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommercePaymentMethodRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommercePaymentM httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommercePaymentM throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Payments.cs b/lending/Codat/Lending/Payments.cs index e9abb4dbf..f08f6a8b3 100644 --- a/lending/Codat/Lending/Payments.cs +++ b/lending/Codat/Lending/Payments.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IPayments { - /// - /// List payments - /// + /// List payments. + /// /// - /// The *List payments* endpoint returns a list of payments for a given company's connection.
+ /// The *List payments* endpoint returns a list of payments for a given company's connection.
///
/// Payments represent an allocation of money within any customer accounts receivable account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingPaymentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingPaymentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get payment - /// + /// Get payment. + /// /// /// The *Get payment* endpoint returns a single payment for a given paymentId.
///
/// Payments represent an allocation of money within any customer accounts receivable account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingPaymentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingPaymentRequest request, + RetryConfig? retryConfig = null + ); } public class Payments: IPayments { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Payments(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingPaymentsRequest request, RetryConfig? retryConfig = null) + /// + /// List payments. + /// + /// + /// The *List payments* endpoint returns a list of payments for a given company's connection.
+ ///
+ /// Payments represent an allocation of money within any customer accounts receivable account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingPaymentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountingPaymen httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountingPaymen throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingPaymentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get payment. + /// + /// + /// The *Get payment* endpoint returns a single payment for a given paymentId.
+ ///
+ /// Payments represent an allocation of money within any customer accounts receivable account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingPaymentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingPaymentReq httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingPaymentReq throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/ProductCategories.cs b/lending/Codat/Lending/ProductCategories.cs index 22d2757f5..818bc821a 100644 --- a/lending/Codat/Lending/ProductCategories.cs +++ b/lending/Codat/Lending/ProductCategories.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IProductCategories { - /// - /// List product categories - /// + /// List product categories. + /// /// - /// The *List product categories* endpoint returns a list of product categories for a given company's connection.
+ /// The *List product categories* endpoint returns a list of product categories for a given company's connection.
///
- /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+ /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommerceProductCategoriesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceProductCategoriesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get product category - /// + /// Get product category. + /// /// /// The *Get product* endpoint returns a single product for a given productId.
///
- /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+ /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommerceProductCategoryRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommerceProductCategoryRequest request, + RetryConfig? retryConfig = null + ); } public class ProductCategories: IProductCategories { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public ProductCategories(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceProductCategoriesRequest request, RetryConfig? retryConfig = null) + /// + /// List product categories. + /// + /// + /// The *List product categories* endpoint returns a list of product categories for a given company's connection.
+ ///
+ /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceProductCategoriesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommerceP httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommerceP throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceProductCategoryRequest request, RetryConfig? retryConfig = null) + + /// + /// Get product category. + /// + /// + /// The *Get product* endpoint returns a single product for a given productId.
+ ///
+ /// Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceProductCategoryRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommerceProduc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommerceProduc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Products.cs b/lending/Codat/Lending/Products.cs index 43304ff4e..c9ecff241 100644 --- a/lending/Codat/Lending/Products.cs +++ b/lending/Codat/Lending/Products.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface IProducts { - /// - /// List products - /// + /// List products. + /// /// - /// The *List products* endpoint returns a list of products for a given company's connection.
+ /// The *List products* endpoint returns a list of products for a given company's connection.
///
- /// Products are items in the company's inventory that are available for sale.
+ /// Products are items in the company's inventory that are available for sale.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListCommerceProductsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListCommerceProductsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get product - /// + /// Get product. + /// /// /// The *Get product* endpoint returns a single product for a given productId.
///
- /// Products are items in the company's inventory that are available for sale.
+ /// Products are items in the company's inventory that are available for sale.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetCommerceProductRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetCommerceProductRequest request, + RetryConfig? retryConfig = null + ); } public class Products: IProducts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Products(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListCommerceProductsRequest request, RetryConfig? retryConfig = null) + /// + /// List products. + /// + /// + /// The *List products* endpoint returns a list of products for a given company's connection.
+ ///
+ /// Products are items in the company's inventory that are available for sale.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListCommerceProductsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListCommerceProductsRe httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListCommerceProductsRe throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetCommerceProductRequest request, RetryConfig? retryConfig = null) + + /// + /// Get product. + /// + /// + /// The *Get product* endpoint returns a single product for a given productId.
+ ///
+ /// Products are items in the company's inventory that are available for sale.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetCommerceProductRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetCommerceProductRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetCommerceProductRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/ProfitAndLoss.cs b/lending/Codat/Lending/ProfitAndLoss.cs index 4dd571233..25a1ac27d 100644 --- a/lending/Codat/Lending/ProfitAndLoss.cs +++ b/lending/Codat/Lending/ProfitAndLoss.cs @@ -24,43 +24,80 @@ namespace Codat.Lending public interface IProfitAndLoss { - /// - /// Get categorized profit and loss statement - /// + /// Get categorized profit and loss statement. + /// /// /// The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date.
///
/// Codat suggests a category for each account automatically, but you can change it to a more suitable one. ///
- /// - Task GetCategorizedAccountsAsync(GetCategorizedProfitAndLossStatementRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetCategorizedAccountsAsync( + GetCategorizedProfitAndLossStatementRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get profit and loss - /// + /// Get profit and loss. + /// /// /// Gets the latest profit and loss for a company. /// - /// - Task GetAsync(GetAccountingProfitAndLossRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingProfitAndLossRequest request, + RetryConfig? retryConfig = null + ); } public class ProfitAndLoss: IProfitAndLoss { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public ProfitAndLoss(SDKConfig config) { SDKConfiguration = config; } - public async Task GetCategorizedAccountsAsync(GetCategorizedProfitAndLossStatementRequest request, RetryConfig? retryConfig = null) + /// + /// Get categorized profit and loss statement. + /// + /// + /// The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date.
+ ///
+ /// Codat suggests a category for each account automatically, but you can change it to a more suitable one. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetCategorizedAccountsAsync( + GetCategorizedProfitAndLossStatementRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -120,7 +157,7 @@ public async Task GetCategorizedAc httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -225,7 +262,25 @@ public async Task GetCategorizedAc throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingProfitAndLossRequest request, RetryConfig? retryConfig = null) + + /// + /// Get profit and loss. + /// + /// + /// Gets the latest profit and loss for a company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingProfitAndLossRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -285,7 +340,7 @@ public async Task GetAsync(GetAccountingProf httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -389,5 +444,6 @@ public async Task GetAsync(GetAccountingProf throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/PullOperations.cs b/lending/Codat/Lending/PullOperations.cs index 3a8f07c3f..d92261457 100644 --- a/lending/Codat/Lending/PullOperations.cs +++ b/lending/Codat/Lending/PullOperations.cs @@ -24,41 +24,73 @@ namespace Codat.Lending public interface IPullOperations { - /// - /// List pull operations - /// + /// List pull operations. + /// /// /// Gets the pull operation history (datasets) for a given company. /// - /// - Task ListAsync(ListPullOperationsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListPullOperationsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get pull operation - /// + /// Get pull operation. + /// /// /// Retrieve information about a single dataset or pull operation. /// - /// - Task GetAsync(GetPullOperationRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync(GetPullOperationRequest request, RetryConfig? retryConfig = null); } public class PullOperations: IPullOperations { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public PullOperations(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListPullOperationsRequest request, RetryConfig? retryConfig = null) + /// + /// List pull operations. + /// + /// + /// Gets the pull operation history (datasets) for a given company. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListPullOperationsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -118,7 +150,7 @@ public async Task ListAsync(ListPullOperationsReques httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -223,7 +255,25 @@ public async Task ListAsync(ListPullOperationsReques throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetPullOperationRequest request, RetryConfig? retryConfig = null) + + /// + /// Get pull operation. + /// + /// + /// Retrieve information about a single dataset or pull operation. + /// + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetPullOperationRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -283,7 +333,7 @@ public async Task GetAsync(GetPullOperationRequest req httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -387,5 +437,6 @@ public async Task GetAsync(GetPullOperationRequest req throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Refresh.cs b/lending/Codat/Lending/Refresh.cs index df7ed55dc..30a98c0c1 100644 --- a/lending/Codat/Lending/Refresh.cs +++ b/lending/Codat/Lending/Refresh.cs @@ -24,10 +24,9 @@ namespace Codat.Lending public interface IRefresh { - /// - /// Refresh all data - /// + /// Refresh all data. + /// /// /// Refreshes all data types with `fetch on first link` set to `true` for a given company.
///
@@ -35,36 +34,76 @@ public interface IRefresh ///
/// Read more about data type settings and `fetch on first link`. ///
- /// - Task AllDataTypesAsync(RefreshAllDataTypesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task AllDataTypesAsync( + RefreshAllDataTypesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Refresh data type - /// + /// Refresh data type. + /// /// /// Refreshes a given data type for a given company.
///
/// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. ///
- /// - Task DataTypeAsync(RefreshDataTypeRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DataTypeAsync( + RefreshDataTypeRequest request, + RetryConfig? retryConfig = null + ); } public class Refresh: IRefresh { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Refresh(SDKConfig config) { SDKConfiguration = config; } - public async Task AllDataTypesAsync(RefreshAllDataTypesRequest request, RetryConfig? retryConfig = null) + /// + /// Refresh all data. + /// + /// + /// Refreshes all data types with `fetch on first link` set to `true` for a given company.
+ ///
+ /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+ ///
+ /// Read more about data type settings and `fetch on first link`. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task AllDataTypesAsync( + RefreshAllDataTypesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -124,7 +163,7 @@ public async Task AllDataTypesAsync(RefreshAllDataT httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -211,7 +250,27 @@ public async Task AllDataTypesAsync(RefreshAllDataT throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DataTypeAsync(RefreshDataTypeRequest request, RetryConfig? retryConfig = null) + + /// + /// Refresh data type. + /// + /// + /// Refreshes a given data type for a given company.
+ ///
+ /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DataTypeAsync( + RefreshDataTypeRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -271,7 +330,7 @@ public async Task DataTypeAsync(RefreshDataTypeRequest httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -375,5 +434,6 @@ public async Task DataTypeAsync(RefreshDataTypeRequest throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Reports.cs b/lending/Codat/Lending/Reports.cs index 3001b7876..ce5270d74 100644 --- a/lending/Codat/Lending/Reports.cs +++ b/lending/Codat/Lending/Reports.cs @@ -24,20 +24,19 @@ namespace Codat.Lending public interface IReports { - /// - /// Get orders report - /// + /// Get orders report. + /// /// - /// The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.
+ /// The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.
///
- /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
///
/// Learn more about the formulas used to calculate the order metrics.
///
/// #### Response structure
///
- /// The Orders report's dimensions and measures are:
+ /// The Orders report's dimensions and measures are:
///
/// | Index | Dimensions |
/// |---------------|----------------|
@@ -49,25 +48,34 @@ public interface IReports /// | `index` = 0 | Count |
/// | `index` = 1 | Value |
///
- /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
- /// + /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. ///
- /// - Task GetOrdersAsync(GetCommerceOrdersReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetOrdersAsync( + GetCommerceOrdersReportRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get refunds report - /// + /// Get refunds report. + /// /// - /// The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.
+ /// The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.
///
- /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
///
/// Learn more about the formulas used to calculate the refunds metrics.
///
/// #### Response structure
///
- /// The Refunds report's dimensions and measures are:
+ /// The Refunds report's dimensions and measures are:
///
/// | Index | Dimensions |
/// |----------------|----------------|
@@ -80,28 +88,73 @@ public interface IReports /// | `index` = 1 | Value |
/// | `index` = 2 | Percentage |
///
- /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
- /// + /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. ///
- /// - Task GetRefundsAsync(GetCommerceRefundsReportRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetRefundsAsync( + GetCommerceRefundsReportRequest request, + RetryConfig? retryConfig = null + ); } public class Reports: IReports { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Reports(SDKConfig config) { SDKConfiguration = config; } - public async Task GetOrdersAsync(GetCommerceOrdersReportRequest request, RetryConfig? retryConfig = null) + /// + /// Get orders report. + /// + /// + /// The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.
+ ///
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ ///
+ /// Learn more about the formulas used to calculate the order metrics.
+ ///
+ /// #### Response structure
+ ///
+ /// The Orders report's dimensions and measures are:
+ ///
+ /// | Index | Dimensions |
+ /// |---------------|----------------|
+ /// | `index` = 0 | Period |
+ /// | `index` = 1 | Order metrics |
+ ///
+ /// | Index | Measures |
+ /// |---------------|------------|
+ /// | `index` = 0 | Count |
+ /// | `index` = 1 | Value |
+ ///
+ /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetOrdersAsync( + GetCommerceOrdersReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -161,7 +214,7 @@ public async Task GetOrdersAsync(GetCommerceOrd httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -266,7 +319,46 @@ public async Task GetOrdersAsync(GetCommerceOrd throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetRefundsAsync(GetCommerceRefundsReportRequest request, RetryConfig? retryConfig = null) + + /// + /// Get refunds report. + /// + /// + /// The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.
+ ///
+ /// This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+ ///
+ /// Learn more about the formulas used to calculate the refunds metrics.
+ ///
+ /// #### Response structure
+ ///
+ /// The Refunds report's dimensions and measures are:
+ ///
+ /// | Index | Dimensions |
+ /// |----------------|----------------|
+ /// | `index` = 0 | Period |
+ /// | `index` = 1 | Refund metrics |
+ ///
+ /// | Index | Measures |
+ /// |----------------|------------|
+ /// | `index` = 0 | Count |
+ /// | `index` = 1 | Value |
+ /// | `index` = 2 | Percentage |
+ ///
+ /// The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetRefundsAsync( + GetCommerceRefundsReportRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -326,7 +418,7 @@ public async Task GetRefundsAsync(GetCommerceR httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -430,5 +522,6 @@ public async Task GetRefundsAsync(GetCommerceR throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/SDKConfig.cs b/lending/Codat/Lending/SDKConfig.cs index cf2683a81..7f68a0043 100644 --- a/lending/Codat/Lending/SDKConfig.cs +++ b/lending/Codat/Lending/SDKConfig.cs @@ -17,6 +17,9 @@ namespace Codat.Lending using System.Collections.Generic; using System.Linq; + /// + /// Main configuration for the SDK. + /// public struct SDKConfig { /// @@ -42,7 +45,7 @@ public SDKConfig(ISpeakeasyHttpClient? client = null) Client = client ?? new SpeakeasyHttpClient(); ServerUrl = ""; ServerIndex = 0; - UserAgent = "speakeasy-sdk/csharp 10.0.0 2.797.1 3.0.0 Codat.Lending"; + UserAgent = "speakeasy-sdk/csharp 10.0.1 2.803.3 3.0.0 Codat.Lending"; SecuritySource = null; Hooks = new SDKHooks(); RetryConfig = null; @@ -57,4 +60,4 @@ public string GetTemplatedServerUrl() return Utilities.TemplateUrl(SDKConfig.ServerList[this.ServerIndex], new Dictionary()); } } -} \ No newline at end of file +} diff --git a/lending/Codat/Lending/Sales.cs b/lending/Codat/Lending/Sales.cs index 77acc24b8..9ed0ed36c 100644 --- a/lending/Codat/Lending/Sales.cs +++ b/lending/Codat/Lending/Sales.cs @@ -17,36 +17,100 @@ namespace Codat.Lending public interface ISales { public IMetrics Metrics { get; } + public IReports Reports { get; } + public ICodatLendingCustomers Customers { get; } + public IDisputes Disputes { get; } + public ILocations Locations { get; } + public IOrders Orders { get; } + public IPaymentMethods PaymentMethods { get; } + public ICodatLendingPayments Payments { get; } + public IProductCategories ProductCategories { get; } + public IProducts Products { get; } + public ICodatLendingSalesTransactions Transactions { get; } } public class Sales: ISales { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// Metrics SubSDK. + /// + /// public IMetrics Metrics { get; private set; } + + /// + /// Reports SubSDK. + /// + /// public IReports Reports { get; private set; } + + /// + /// Customers SubSDK. + /// + /// public ICodatLendingCustomers Customers { get; private set; } + + /// + /// Disputes SubSDK. + /// + /// public IDisputes Disputes { get; private set; } + + /// + /// Locations SubSDK. + /// + /// public ILocations Locations { get; private set; } + + /// + /// Orders SubSDK. + /// + /// public IOrders Orders { get; private set; } + + /// + /// PaymentMethods SubSDK. + /// + /// public IPaymentMethods PaymentMethods { get; private set; } + + /// + /// Payments SubSDK. + /// + /// public ICodatLendingPayments Payments { get; private set; } + + /// + /// ProductCategories SubSDK. + /// + /// public IProductCategories ProductCategories { get; private set; } + + /// + /// Products SubSDK. + /// + /// public IProducts Products { get; private set; } + + /// + /// Transactions SubSDK. + /// + /// public ICodatLendingSalesTransactions Transactions { get; private set; } public Sales(SDKConfig config) diff --git a/lending/Codat/Lending/SourceAccounts.cs b/lending/Codat/Lending/SourceAccounts.cs index af63d1015..b0f1c8b0d 100644 --- a/lending/Codat/Lending/SourceAccounts.cs +++ b/lending/Codat/Lending/SourceAccounts.cs @@ -24,41 +24,60 @@ namespace Codat.Lending public interface ISourceAccounts { - /// - /// Create source account - /// + /// Create source account. + /// /// - /// The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software.
+ /// The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software.
///
/// > ### Versioning
/// > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. ///
- ///
- Task CreateAsync(CreateSourceAccountRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateAsync( + CreateSourceAccountRequest request, + RetryConfig? retryConfig = null + ); /// - /// List bank feed account mappings - /// + /// List bank feed account mappings. + /// /// /// The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts.
///
- /// A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
+ /// A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
///
/// > **For custom builds only**
/// >
/// > Only use this endpoint if you are building your own account management UI. ///
- /// - Task ListMappingsAsync(GetBankAccountMappingRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListMappingsAsync( + GetBankAccountMappingRequest request, + RetryConfig? retryConfig = null + ); /// - /// Create bank feed account mapping - /// + /// Create bank feed account mapping. + /// /// /// The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account).
///
- /// A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
+ /// A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
///
/// To find valid target account options, first call the List bank feed account mappings endpoint.
///
@@ -73,7 +92,7 @@ public interface ISourceAccounts /// #### Mapping options:
///
/// 1. **API Mapping**: Integrate the mapping journey directly into your application for a seamless user experience.
- /// 2. **Codat UI Mapping**: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.
+ /// 2. **Codat UI Mapping**: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.
/// 3. **Accounting Platform Mapping**: For some accounting software, the mapping process must be conducted within the software itself.
///
/// ### Integration-specific behavior
@@ -87,25 +106,54 @@ public interface ISourceAccounts /// | QuickBooks Online | | | ✅ |
/// | Sage | | | ✅ | ///
- /// - Task CreateMappingAsync(CreateBankAccountMappingRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task CreateMappingAsync( + CreateBankAccountMappingRequest request, + RetryConfig? retryConfig = null + ); } public class SourceAccounts: ISourceAccounts { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public SourceAccounts(SDKConfig config) { SDKConfiguration = config; } - public async Task CreateAsync(CreateSourceAccountRequest request, RetryConfig? retryConfig = null) + /// + /// Create source account. + /// + /// + /// The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software.
+ ///
+ /// > ### Versioning
+ /// > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateAsync( + CreateSourceAccountRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -171,7 +219,7 @@ public async Task CreateAsync(CreateSourceAccountRe httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -276,7 +324,31 @@ public async Task CreateAsync(CreateSourceAccountRe throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListMappingsAsync(GetBankAccountMappingRequest request, RetryConfig? retryConfig = null) + + /// + /// List bank feed account mappings. + /// + /// + /// The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts.
+ ///
+ /// A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
+ ///
+ /// > **For custom builds only**
+ /// >
+ /// > Only use this endpoint if you are building your own account management UI. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListMappingsAsync( + GetBankAccountMappingRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -336,7 +408,7 @@ public async Task ListMappingsAsync(GetBankAccoun httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -441,7 +513,54 @@ public async Task ListMappingsAsync(GetBankAccoun throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task CreateMappingAsync(CreateBankAccountMappingRequest request, RetryConfig? retryConfig = null) + + /// + /// Create bank feed account mapping. + /// + /// + /// The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account).
+ ///
+ /// A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
+ ///
+ /// To find valid target account options, first call the List bank feed account mappings endpoint.
+ ///
+ /// > **For custom builds only**
+ /// >
+ /// > Only use this endpoint if you are building your own account management UI.
+ ///
+ /// #### Account mapping variability
+ ///
+ /// The method of mapping the source account to the target account varies depending on the accounting software your company uses.
+ ///
+ /// #### Mapping options:
+ ///
+ /// 1. **API Mapping**: Integrate the mapping journey directly into your application for a seamless user experience.
+ /// 2. **Codat UI Mapping**: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.
+ /// 3. **Accounting Platform Mapping**: For some accounting software, the mapping process must be conducted within the software itself.
+ ///
+ /// ### Integration-specific behavior
+ ///
+ /// | Bank Feed Integration | API Mapping | Codat UI Mapping | Accounting Platform Mapping |
+ /// | --------------------- | ----------- | ---------------- | --------------------------- |
+ /// | Xero | ✅ | ✅ | |
+ /// | FreeAgent | ✅ | ✅ | |
+ /// | Oracle NetSuite | ✅ | ✅ | |
+ /// | Exact Online (NL) | ✅ | ✅ | |
+ /// | QuickBooks Online | | | ✅ |
+ /// | Sage | | | ✅ | + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// The request made is not valid. Thrown when the API returns a 400, 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task CreateMappingAsync( + CreateBankAccountMappingRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -507,7 +626,7 @@ public async Task CreateMappingAsync(CreateBan httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -611,5 +730,6 @@ public async Task CreateMappingAsync(CreateBan throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Suppliers.cs b/lending/Codat/Lending/Suppliers.cs index 1ca1de200..d2cc8276e 100644 --- a/lending/Codat/Lending/Suppliers.cs +++ b/lending/Codat/Lending/Suppliers.cs @@ -24,87 +24,151 @@ namespace Codat.Lending public interface ISuppliers { - /// - /// List suppliers - /// + /// List suppliers. + /// /// - /// The *List suppliers* endpoint returns a list of suppliers for a given company's connection.
+ /// The *List suppliers* endpoint returns a list of suppliers for a given company's connection.
///
/// Suppliers are people or organizations that provide something, such as a product or service.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingSuppliersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingSuppliersRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get supplier - /// + /// Get supplier. + /// /// /// The *Get supplier* endpoint returns a single supplier for a given supplierId.
///
/// Suppliers are people or organizations that provide something, such as a product or service.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingSupplierRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingSupplierRequest request, + RetryConfig? retryConfig = null + ); /// - /// List supplier attachments - /// + /// List supplier attachments. + /// /// /// The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.
///
- /// Suppliers are people or organizations that provide something, such as a product or service.
- /// + /// Suppliers are people or organizations that provide something, such as a product or service. ///
- /// - Task ListAttachmentsAsync(ListAccountingSupplierAttachmentsRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAttachmentsAsync( + ListAccountingSupplierAttachmentsRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get supplier attachment - /// + /// Get supplier attachment. + /// /// /// The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.
///
- /// Suppliers are people or organizations that provide something, such as a product or service.
- /// + /// Suppliers are people or organizations that provide something, such as a product or service. ///
- /// - Task GetAttachmentAsync(GetAccountingSupplierAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAttachmentAsync( + GetAccountingSupplierAttachmentRequest request, + RetryConfig? retryConfig = null + ); /// - /// Download supplier attachment - /// + /// Download supplier attachment. + /// /// /// The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.
///
- /// Suppliers are people or organizations that provide something, such as a product or service.
- /// + /// Suppliers are people or organizations that provide something, such as a product or service. ///
- /// - Task DownloadAttachmentAsync(DownloadAccountingSupplierAttachmentRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task DownloadAttachmentAsync( + DownloadAccountingSupplierAttachmentRequest request, + RetryConfig? retryConfig = null + ); } public class Suppliers: ISuppliers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Suppliers(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingSuppliersRequest request, RetryConfig? retryConfig = null) + /// + /// List suppliers. + /// + /// + /// The *List suppliers* endpoint returns a list of suppliers for a given company's connection.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingSuppliersRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -164,7 +228,7 @@ public async Task ListAsync(ListAccountingSuppl httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -269,7 +333,29 @@ public async Task ListAsync(ListAccountingSuppl throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingSupplierRequest request, RetryConfig? retryConfig = null) + + /// + /// Get supplier. + /// + /// + /// The *Get supplier* endpoint returns a single supplier for a given supplierId.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingSupplierRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -329,7 +415,7 @@ public async Task GetAsync(GetAccountingSupplierR httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -434,7 +520,27 @@ public async Task GetAsync(GetAccountingSupplierR throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task ListAttachmentsAsync(ListAccountingSupplierAttachmentsRequest request, RetryConfig? retryConfig = null) + + /// + /// List supplier attachments. + /// + /// + /// The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAttachmentsAsync( + ListAccountingSupplierAttachmentsRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -494,7 +600,7 @@ public async Task ListAttachmentsAsyn httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -599,7 +705,27 @@ public async Task ListAttachmentsAsyn throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAttachmentAsync(GetAccountingSupplierAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Get supplier attachment. + /// + /// + /// The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAttachmentAsync( + GetAccountingSupplierAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -659,7 +785,7 @@ public async Task GetAttachmentAsync(Ge httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -764,7 +890,27 @@ public async Task GetAttachmentAsync(Ge throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task DownloadAttachmentAsync(DownloadAccountingSupplierAttachmentRequest request, RetryConfig? retryConfig = null) + + /// + /// Download supplier attachment. + /// + /// + /// The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.
+ ///
+ /// Suppliers are people or organizations that provide something, such as a product or service. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task DownloadAttachmentAsync( + DownloadAccountingSupplierAttachmentRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -824,7 +970,7 @@ public async Task DownloadAttachme httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -917,5 +1063,6 @@ public async Task DownloadAttachme throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/TransactionCategories.cs b/lending/Codat/Lending/TransactionCategories.cs index 2547415df..902f30995 100644 --- a/lending/Codat/Lending/TransactionCategories.cs +++ b/lending/Codat/Lending/TransactionCategories.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ITransactionCategories { - /// - /// List transaction categories - /// + /// List transaction categories. + /// /// - /// The *List transaction categories* endpoint returns a list of transaction categories for a given company's connection.
+ /// The *List transaction categories* endpoint returns a list of transaction categories for a given company's connection.
///
/// Transaction categories are associated with a transaction to provide greater contextual meaning to transaction activity.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListBankingTransactionCategoriesRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListBankingTransactionCategoriesRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get transaction category - /// + /// Get transaction category. + /// /// /// The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.
///
/// Transaction categories are associated with a transaction to provide greater contextual meaning to transaction activity.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetBankingTransactionCategoryRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetBankingTransactionCategoryRequest request, + RetryConfig? retryConfig = null + ); } public class TransactionCategories: ITransactionCategories { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public TransactionCategories(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListBankingTransactionCategoriesRequest request, RetryConfig? retryConfig = null) + /// + /// List transaction categories. + /// + /// + /// The *List transaction categories* endpoint returns a list of transaction categories for a given company's connection.
+ ///
+ /// Transaction categories are associated with a transaction to provide greater contextual meaning to transaction activity.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListBankingTransactionCategoriesRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListBankin httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListBankin throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetBankingTransactionCategoryRequest request, RetryConfig? retryConfig = null) + + /// + /// Get transaction category. + /// + /// + /// The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.
+ ///
+ /// Transaction categories are associated with a transaction to provide greater contextual meaning to transaction activity.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetBankingTransactionCategoryRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetBankingTran httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetBankingTran throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Transactions.cs b/lending/Codat/Lending/Transactions.cs index e8c0f639d..0df74a164 100644 --- a/lending/Codat/Lending/Transactions.cs +++ b/lending/Codat/Lending/Transactions.cs @@ -17,24 +17,52 @@ namespace Codat.Lending public interface ITransactions { public IAccountTransactions AccountTransactions { get; } + public IDirectCosts DirectCosts { get; } + public IJournalEntries JournalEntries { get; } + public IJournals Journals { get; } + public ITransfers Transfers { get; } } public class Transactions: ITransactions { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; + /// + /// AccountTransactions SubSDK. + /// + /// public IAccountTransactions AccountTransactions { get; private set; } + + /// + /// DirectCosts SubSDK. + /// + /// public IDirectCosts DirectCosts { get; private set; } + + /// + /// JournalEntries SubSDK. + /// + /// public IJournalEntries JournalEntries { get; private set; } + + /// + /// Journals SubSDK. + /// + /// public IJournals Journals { get; private set; } + + /// + /// Transfers SubSDK. + /// + /// public ITransfers Transfers { get; private set; } public Transactions(SDKConfig config) diff --git a/lending/Codat/Lending/Transfers.cs b/lending/Codat/Lending/Transfers.cs index b97bc0785..ea28a7660 100644 --- a/lending/Codat/Lending/Transfers.cs +++ b/lending/Codat/Lending/Transfers.cs @@ -24,51 +24,88 @@ namespace Codat.Lending public interface ITransfers { - /// - /// List transfers - /// + /// List transfers. + /// /// - /// The *List transfers* endpoint returns a list of transfers for a given company's connection.
+ /// The *List transfers* endpoint returns a list of transfers for a given company's connection.
///
/// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task ListAsync(ListAccountingTransfersRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task ListAsync( + ListAccountingTransfersRequest request, + RetryConfig? retryConfig = null + ); /// - /// Get transfer - /// + /// Get transfer. + /// /// /// The *Get transfer* endpoint returns a single transfer for a given transferId.
///
/// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
///
- /// Before using this endpoint, you must have retrieved data for the company.
- /// + /// Before using this endpoint, you must have retrieved data for the company. ///
- /// - Task GetAsync(GetAccountingTransferRequest request, RetryConfig? retryConfig = null); + /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public Task GetAsync( + GetAccountingTransferRequest request, + RetryConfig? retryConfig = null + ); } public class Transfers: ITransfers { + /// + /// SDK Configuration. + /// + /// public SDKConfig SDKConfiguration { get; private set; } - private const string _language = Constants.Language; - private const string _sdkVersion = Constants.SdkVersion; - private const string _sdkGenVersion = Constants.SdkGenVersion; - private const string _openapiDocVersion = Constants.OpenApiDocVersion; - public Transfers(SDKConfig config) { SDKConfiguration = config; } - public async Task ListAsync(ListAccountingTransfersRequest request, RetryConfig? retryConfig = null) + /// + /// List transfers. + /// + /// + /// The *List transfers* endpoint returns a list of transfers for a given company's connection.
+ ///
+ /// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your `query` parameter was not correctly formed. Thrown when the API returns a 400, 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task ListAsync( + ListAccountingTransfersRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -128,7 +165,7 @@ public async Task ListAsync(ListAccountingTrans httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 400 || _statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -233,7 +270,29 @@ public async Task ListAsync(ListAccountingTrans throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } - public async Task GetAsync(GetAccountingTransferRequest request, RetryConfig? retryConfig = null) + + /// + /// Get transfer. + /// + /// + /// The *Get transfer* endpoint returns a single transfer for a given transferId.
+ ///
+ /// Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + ///
+ /// A parameter. + /// The retry configuration to use for this operation. + /// An awaitable task that returns a response envelope when completed. + /// The required parameter is null. + /// The HTTP request failed due to network issues. + /// The response body could not be deserialized. + /// Your API request was not properly authorized. Thrown when the API returns a 401, 402, 403, 404, 409, 429, 500 or 503 response. + /// Default API Exception. Thrown when the API returns a 4XX or 5XX response. + public async Task GetAsync( + GetAccountingTransferRequest request, + RetryConfig? retryConfig = null + ) { if (request == null) throw new ArgumentNullException(nameof(request)); @@ -293,7 +352,7 @@ public async Task GetAsync(GetAccountingTransferR httpResponse = await retries.Run(); int _statusCode = (int)httpResponse.StatusCode; - if (_statusCode == 401 || _statusCode == 402 || _statusCode == 403 || _statusCode == 404 || _statusCode == 409 || _statusCode == 429 || _statusCode >= 400 && _statusCode < 500 || _statusCode == 500 || _statusCode == 503 || _statusCode >= 500 && _statusCode < 600) + if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) { var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); if (_httpResponse != null) @@ -397,5 +456,6 @@ public async Task GetAsync(GetAccountingTransferR throw new Models.Errors.SDKException("Unknown status code received", httpResponse, await httpResponse.Content.ReadAsStringAsync()); } + } } \ No newline at end of file diff --git a/lending/Codat/Lending/Utils/Constants.cs b/lending/Codat/Lending/Utils/Constants.cs index 6b9c37f10..09dce91e6 100644 --- a/lending/Codat/Lending/Utils/Constants.cs +++ b/lending/Codat/Lending/Utils/Constants.cs @@ -22,12 +22,12 @@ public static class Constants /// /// The version of the SDK. /// - public const string SdkVersion = "10.0.0"; + public const string SdkVersion = "10.0.1"; /// /// The version of the SDK generator used to create this SDK. /// - public const string SdkGenVersion = "2.797.1"; + public const string SdkGenVersion = "2.803.3"; /// /// The version of the OpenAPI document used to generate this SDK. diff --git a/lending/Codat/Lending/Utils/Retries/BackoffStrategy.cs b/lending/Codat/Lending/Utils/Retries/BackoffStrategy.cs index 91fcf71b2..b3f313ecf 100644 --- a/lending/Codat/Lending/Utils/Retries/BackoffStrategy.cs +++ b/lending/Codat/Lending/Utils/Retries/BackoffStrategy.cs @@ -9,6 +9,9 @@ #nullable enable namespace Codat.Lending.Utils.Retries { + /// + /// Exponential backoff strategy configuration. + /// public class BackoffStrategy { public readonly long InitialIntervalMs; diff --git a/lending/Codat/Lending/Utils/Retries/Retries.cs b/lending/Codat/Lending/Utils/Retries/Retries.cs index 12a98fee8..26a1023f8 100644 --- a/lending/Codat/Lending/Utils/Retries/Retries.cs +++ b/lending/Codat/Lending/Utils/Retries/Retries.cs @@ -15,12 +15,22 @@ namespace Codat.Lending.Utils.Retries using System.Threading.Tasks; using Models.Errors; + /// + /// Handles retry logic for HTTP requests with configurable backoff strategies. + /// public class Retries { private Func> action; private RetryConfig retryConfig; private List statusCodes; + /// + /// Initializes a new instance of the class. + /// + /// The HTTP action to execute and potentially retry. + /// The retry configuration specifying strategy and backoff parameters. + /// The list of HTTP status codes that should trigger retries. + /// Thrown when the statusCodes list is empty. public Retries(Func> action, RetryConfig retryConfig, List statusCodes) { this.action = action; @@ -33,11 +43,17 @@ public Retries(Func> action, RetryConfig retryConfig, } } + /// + /// Exception indicating a non-retryable error that should be immediately propagated. + /// public sealed class PermanentException : Exception { public PermanentException(Exception innerException) : base("NonRetryable error.", innerException) { } } + /// + /// Exception indicating a retryable error that may succeed on subsequent attempts. + /// public sealed class RetryableException : Exception { public HttpResponseMessage? Response = null; @@ -49,6 +65,11 @@ public RetryableException(HttpResponseMessage response) { public RetryableException(Exception innerException) : base("An error occurred.", innerException) { } } + /// + /// Executes the configured HTTP action with retry logic based on the retry strategy. + /// + /// The HTTP response message from the successful request. + /// Thrown when the retry strategy is invalid. public async Task Run() { switch(retryConfig.Strategy) { diff --git a/lending/Codat/Lending/Utils/Retries/RetryConfig.cs b/lending/Codat/Lending/Utils/Retries/RetryConfig.cs index e9ba0faa5..d5b5fc2f9 100644 --- a/lending/Codat/Lending/Utils/Retries/RetryConfig.cs +++ b/lending/Codat/Lending/Utils/Retries/RetryConfig.cs @@ -11,13 +11,24 @@ namespace Codat.Lending.Utils.Retries { public class RetryConfig { + /// + /// Available retry strategies. + /// public enum RetryStrategy { + /// Exponential backoff strategy. BACKOFF, + /// Disabled (no retries). NONE } + + /// The retry strategy. public readonly RetryStrategy Strategy; + + /// The backoff strategy configuration (if applicable). public readonly BackoffStrategy? Backoff; + + /// Whether to retry on connection errors. public readonly bool RetryConnectionErrors; /// diff --git a/lending/Codat/Lending/Utils/Utilities.cs b/lending/Codat/Lending/Utils/Utilities.cs index 633726d1b..ee59d7c1a 100644 --- a/lending/Codat/Lending/Utils/Utilities.cs +++ b/lending/Codat/Lending/Utils/Utilities.cs @@ -303,6 +303,7 @@ public static string PrefixBearer(string authHeaderValue) return $"Bearer {authHeaderValue}"; } + public static string RemoveSuffix(string inputString, string suffix) { if (!String.IsNullOrEmpty(suffix) && inputString.EndsWith(suffix)) @@ -311,6 +312,7 @@ public static string RemoveSuffix(string inputString, string suffix) } return inputString; } + public static string TemplateUrl(string template, Dictionary paramDict) { foreach(KeyValuePair entry in paramDict) @@ -319,5 +321,19 @@ public static string TemplateUrl(string template, Dictionary par } return template; } + + public static Dictionary> CollectHeaders(HttpHeaders headers) + { + var dict = new Dictionary>(StringComparer.OrdinalIgnoreCase); + foreach (var header in headers) + { + if (!dict.ContainsKey(header.Key)) + { + dict[header.Key] = new List(); + } + dict[header.Key].AddRange(header.Value); + } + return dict; + } } } diff --git a/lending/RELEASES.md b/lending/RELEASES.md index 69f9388ac..520057d41 100644 --- a/lending/RELEASES.md +++ b/lending/RELEASES.md @@ -282,4 +282,14 @@ Based on: ### Generated - [csharp v10.0.0] lending ### Releases -- [NuGet v10.0.0] https://www.nuget.org/packages/Codat.Lending/10.0.0 - lending \ No newline at end of file +- [NuGet v10.0.0] https://www.nuget.org/packages/Codat.Lending/10.0.0 - lending + +## 2026-02-04 11:25:48 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.701.0 (2.803.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v10.0.1] lending +### Releases +- [NuGet v10.0.1] https://www.nuget.org/packages/Codat.Lending/10.0.1 - lending \ No newline at end of file diff --git a/lending/docs/Models/Components/CashFlowTransaction.md b/lending/docs/Models/Components/CashFlowTransaction.md index 001eabc44..33ba6e464 100644 --- a/lending/docs/Models/Components/CashFlowTransaction.md +++ b/lending/docs/Models/Components/CashFlowTransaction.md @@ -15,4 +15,5 @@ | `CounterpartyNames` | List<*string*> | :heavy_minus_sign: | An array of counterparty names involved in the transaction. | | | `SourceRef` | [SourceRef](../../Models/Components/SourceRef.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | {
"Example": {
"value": {
"sourceRef": {
"sourceType": "Banking"
}
}
}
} | | `AccountRef` | [AccountRef](../../Models/Components/AccountRef.md) | :heavy_minus_sign: | An account reference containing the account id and name. | {
"Example": {
"value": {
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
}
}
}
} | -| `ModifiedDate` | *string* | :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-23T00:00:00Z | \ No newline at end of file +| `ModifiedDate` | *string* | :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-23T00:00:00Z | +| `IsRecurring` | *bool* | :heavy_minus_sign: | Indicates if the transaction is classified as recurring by Codat's categorization engine. | | \ No newline at end of file diff --git a/lending/docs/sdks/bankstatements/README.md b/lending/docs/sdks/bankstatements/README.md index bff53b95f..1ae8e5692 100644 --- a/lending/docs/sdks/bankstatements/README.md +++ b/lending/docs/sdks/bankstatements/README.md @@ -179,23 +179,11 @@ UploadBankStatementDataRequest req = new UploadBankStatementDataRequest() { new Dictionary() { { "results", new List() { new Dictionary() { - { "institution", new Dictionary() { - { "name", "Lloyds Bank" }, - { "id", "lloyds-bank" }, - } }, - { "modifiedDate", "2022-05-23T16:32:50Z" }, - { "sourceModifiedDate", "2021-08-14T05:04:12" }, - { "informalName", "Codat" }, { "balance", new Dictionary() { - { "limit", 5000 }, { "available", -459987.97D }, { "current", -459964.9D }, + { "limit", 5000 }, } }, - { "currency", "GBP" }, - { "id", "1703194f-7805-4da8-bac0-2ba5da4a4216" }, - { "name", "Business Current Account" }, - { "holder", "Codat Ltd" }, - { "type", "Debit" }, { "identifiers", new Dictionary() { { "bic", "LOYDGB21006" }, { "maskedAccountNumber", "LOYDGB21006" }, @@ -205,6 +193,18 @@ UploadBankStatementDataRequest req = new UploadBankStatementDataRequest() { { "bankCode", 9911 }, { "iban", "GB29 LOYD 4773 2346 7626 29" }, } }, + { "institution", new Dictionary() { + { "id", "lloyds-bank" }, + { "name", "Lloyds Bank" }, + } }, + { "modifiedDate", "2022-05-23T16:32:50Z" }, + { "holder", "Codat Ltd" }, + { "currency", "GBP" }, + { "sourceModifiedDate", "2021-08-14T05:04:12" }, + { "id", "1703194f-7805-4da8-bac0-2ba5da4a4216" }, + { "name", "Business Current Account" }, + { "informalName", "Codat" }, + { "type", "Debit" }, }, } }, }