@codat/lending 4.2.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -1
- package/dist/sdk/companies.d.ts +22 -7
- package/dist/sdk/companies.js +22 -7
- package/dist/sdk/models/operations/getcreateoperation.d.ts +1 -1
- package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +2 -2
- package/dist/sdk/models/shared/accountingbillcreditnote.js +3 -3
- package/dist/sdk/models/shared/accountingcreateaccountresponse.d.ts +171 -34
- package/dist/sdk/models/shared/accountingcreateaccountresponse.js +194 -4
- package/dist/sdk/models/shared/accountingcreatebankaccountresponse.d.ts +116 -22
- package/dist/sdk/models/shared/accountingcreatebankaccountresponse.js +118 -4
- package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.d.ts +12 -2
- package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.js +26 -4
- package/dist/sdk/models/shared/accountingcreatedirectcostresponse.d.ts +165 -18
- package/dist/sdk/models/shared/accountingcreatedirectcostresponse.js +150 -4
- package/dist/sdk/models/shared/accountingcreatepaymentresponse.d.ts +797 -675
- package/dist/sdk/models/shared/accountingcreatepaymentresponse.js +782 -4
- package/dist/sdk/models/shared/accountingcreatesupplierresponse.d.ts +69 -11
- package/dist/sdk/models/shared/accountingcreatesupplierresponse.js +99 -4
- package/dist/sdk/models/shared/accountingcreatetransferresponse.d.ts +81 -9
- package/dist/sdk/models/shared/accountingcreatetransferresponse.js +93 -4
- package/dist/sdk/models/shared/accountingcreditnote.d.ts +2 -2
- package/dist/sdk/models/shared/accountingcreditnote.js +3 -3
- package/dist/sdk/models/shared/accountingdirectcost.d.ts +11 -5
- package/dist/sdk/models/shared/accountingdirectcost.js +18 -11
- package/dist/sdk/models/shared/accountinginvoice.d.ts +10 -5
- package/dist/sdk/models/shared/accountinginvoice.js +11 -5
- package/dist/sdk/models/shared/accountingjournalentry.d.ts +3 -7
- package/dist/sdk/models/shared/accountingjournalentry.js +3 -3
- package/dist/sdk/models/shared/accounttransactionline.d.ts +3 -7
- package/dist/sdk/models/shared/accounttransactionline.js +3 -3
- package/dist/sdk/models/shared/accounttransactionlinerecordref.d.ts +30 -0
- package/dist/sdk/models/shared/accounttransactionlinerecordref.js +70 -0
- package/dist/sdk/models/shared/bankingtransactioncategory.d.ts +5 -1
- package/dist/sdk/models/shared/bankingtransactioncategory.js +5 -1
- package/dist/sdk/models/shared/company.d.ts +10 -0
- package/dist/sdk/models/shared/company.js +20 -1
- package/dist/sdk/models/shared/companyrequestbody.d.ts +5 -0
- package/dist/sdk/models/shared/companyrequestbody.js +7 -0
- package/dist/sdk/models/shared/connection.d.ts +2 -0
- package/dist/sdk/models/shared/connection.js +2 -0
- package/dist/sdk/models/shared/contactref.d.ts +9 -3
- package/dist/sdk/models/shared/contactref.js +9 -2
- package/dist/sdk/models/shared/directcostprototype.d.ts +11 -5
- package/dist/sdk/models/shared/directcostprototype.js +18 -11
- package/dist/sdk/models/shared/errormessage.d.ts +5 -0
- package/dist/sdk/models/shared/errormessage.js +7 -0
- package/dist/sdk/models/shared/errorvalidation.d.ts +9 -0
- package/dist/sdk/models/shared/errorvalidation.js +56 -0
- package/dist/sdk/models/shared/errorvalidationitem.d.ts +15 -0
- package/dist/sdk/models/shared/errorvalidationitem.js +55 -0
- package/dist/sdk/models/shared/index.d.ts +6 -0
- package/dist/sdk/models/shared/index.js +6 -0
- package/dist/sdk/models/shared/invoicelineitem.d.ts +0 -2
- package/dist/sdk/models/shared/items.d.ts +2 -6
- package/dist/sdk/models/shared/items.js +2 -7
- package/dist/sdk/models/shared/journalentryrecordref.d.ts +30 -0
- package/dist/sdk/models/shared/journalentryrecordref.js +70 -0
- package/dist/sdk/models/shared/journalline.d.ts +2 -2
- package/dist/sdk/models/shared/journalline.js +3 -3
- package/dist/sdk/models/shared/tracking.d.ts +2 -1
- package/dist/sdk/models/shared/tracking.js +3 -2
- package/dist/sdk/models/shared/trackingrecordref.d.ts +22 -0
- package/dist/sdk/models/shared/trackingrecordref.js +62 -0
- package/dist/sdk/models/shared/withholdingtaxitems.d.ts +11 -0
- package/dist/sdk/models/shared/withholdingtaxitems.js +50 -0
- package/dist/sdk/sdk.js +3 -3
- package/docs/sdk/models/operations/createcompanyresponse.md +7 -7
- package/docs/sdk/models/operations/createconnectionresponse.md +7 -7
- package/docs/sdk/models/operations/createsupplierrequest.md +7 -7
- package/docs/sdk/models/operations/getaccountingagedcreditorsreportresponse.md +7 -7
- package/docs/sdk/models/operations/getaccountingageddebtorsreportresponse.md +7 -7
- package/docs/sdk/models/operations/getaccountingbillcreditnoteresponse.md +7 -7
- package/docs/sdk/models/operations/getaccountingbillpaymentresponse.md +7 -7
- package/docs/sdk/models/operations/getaccountingcreditnoteresponse.md +7 -7
- package/docs/sdk/models/operations/getaccountingprofileresponse.md +7 -7
- package/docs/sdk/models/operations/getaccountingsupplierresponse.md +7 -7
- package/docs/sdk/models/operations/getbankingaccountresponse.md +7 -7
- package/docs/sdk/models/operations/getbankingtransactioncategoryresponse.md +7 -7
- package/docs/sdk/models/operations/getbankingtransactionresponse.md +7 -7
- package/docs/sdk/models/operations/getcategorizedbalancesheetstatementresponse.md +7 -7
- package/docs/sdk/models/operations/getcategorizedprofitandlossstatementresponse.md +7 -7
- package/docs/sdk/models/operations/getcommercecustomerresponse.md +7 -7
- package/docs/sdk/models/operations/getcommercedisputeresponse.md +7 -7
- package/docs/sdk/models/operations/getcommercelocationresponse.md +7 -7
- package/docs/sdk/models/operations/getcommerceorderresponse.md +7 -7
- package/docs/sdk/models/operations/getcommerceproductcategoryresponse.md +7 -7
- package/docs/sdk/models/operations/getcompanyresponse.md +7 -7
- package/docs/sdk/models/operations/getconnectionresponse.md +7 -7
- package/docs/sdk/models/operations/getcreateoperationrequest.md +4 -4
- package/docs/sdk/models/operations/getloansummaryresponse.md +7 -7
- package/docs/sdk/models/operations/getpulloperationresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingaccountsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingaccounttransactionsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingbankaccountsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingbankaccounttransactionsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingbillcreditnotesresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingbillpaymentsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingbillsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingcreditnotesresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingcustomersresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingdirectcostsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingdirectincomesresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountinginvoicesresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingjournalentriesresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingjournalsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingsuppliersresponse.md +7 -7
- package/docs/sdk/models/operations/listaccountingtransfersresponse.md +7 -7
- package/docs/sdk/models/operations/listbankingaccountbalancesresponse.md +7 -7
- package/docs/sdk/models/operations/listbankingaccountsresponse.md +7 -7
- package/docs/sdk/models/operations/listbankingtransactioncategoriesresponse.md +7 -7
- package/docs/sdk/models/operations/listbankingtransactionsresponse.md +7 -7
- package/docs/sdk/models/operations/listcommercecustomersresponse.md +7 -7
- package/docs/sdk/models/operations/listcommercedisputesresponse.md +7 -7
- package/docs/sdk/models/operations/listcommercelocationsresponse.md +7 -7
- package/docs/sdk/models/operations/listcommerceordersresponse.md +7 -7
- package/docs/sdk/models/operations/listcommercepaymentmethodsresponse.md +7 -7
- package/docs/sdk/models/operations/listcommercepaymentsresponse.md +7 -7
- package/docs/sdk/models/operations/listcommerceproductcategoriesresponse.md +7 -7
- package/docs/sdk/models/operations/listcommerceproductsresponse.md +7 -7
- package/docs/sdk/models/operations/listcommercetransactionsresponse.md +7 -7
- package/docs/sdk/models/operations/listcompaniesresponse.md +7 -7
- package/docs/sdk/models/operations/listconnectionsresponse.md +7 -7
- package/docs/sdk/models/operations/listcreateoperationsresponse.md +7 -7
- package/docs/sdk/models/operations/listdataintegritydetailsresponse.md +7 -7
- package/docs/sdk/models/operations/listloantransactionsresponse.md +7 -7
- package/docs/sdk/models/operations/listpulloperationsresponse.md +7 -7
- package/docs/sdk/models/operations/refreshdatatyperesponse.md +7 -7
- package/docs/sdk/models/operations/unlinkconnectionresponse.md +7 -7
- package/docs/sdk/models/operations/updatecompanyresponse.md +7 -7
- package/docs/sdk/models/shared/accountingaccounts.md +7 -7
- package/docs/sdk/models/shared/accountingaccounttransactions.md +7 -7
- package/docs/sdk/models/shared/accountingbankaccounts.md +7 -7
- package/docs/sdk/models/shared/accountingbanktransactions.md +7 -7
- package/docs/sdk/models/shared/accountingbillcreditnote.md +1 -1
- package/docs/sdk/models/shared/accountingbillcreditnotes.md +7 -7
- package/docs/sdk/models/shared/accountingbillpayment.md +1 -1
- package/docs/sdk/models/shared/accountingbillpayments.md +7 -7
- package/docs/sdk/models/shared/accountingbills.md +7 -7
- package/docs/sdk/models/shared/accountingcreateaccountresponse.md +16 -16
- package/docs/sdk/models/shared/accountingcreateaccountresponseaccountingaccount.md +54 -0
- package/docs/sdk/models/shared/accountingcreateaccountresponsevaliddatatypelinks.md +50 -0
- package/docs/sdk/models/shared/accountingcreatebankaccountresponse.md +16 -16
- package/docs/sdk/models/shared/accountingcreatebankaccountresponseaccountingbankaccount.md +42 -0
- package/docs/sdk/models/shared/accountingcreatebankaccounttransactions.md +11 -0
- package/docs/sdk/models/shared/accountingcreatebanktransactionsresponse.md +1 -1
- package/docs/sdk/models/shared/accountingcreatedirectcostresponse.md +16 -16
- package/docs/sdk/models/shared/accountingcreatedirectcostresponseaccountingdirectcost.md +41 -0
- package/docs/sdk/models/shared/accountingcreatedirectcostresponsecontactreference.md +11 -0
- package/docs/sdk/models/shared/accountingcreatedirectcostresponsedatatype.md +11 -0
- package/docs/sdk/models/shared/accountingcreatepaymentresponse.md +16 -16
- package/docs/sdk/models/shared/accountingcreatepaymentresponseaccountingpayment.md +703 -0
- package/docs/sdk/models/shared/accountingcreatesupplierresponse.md +1 -1
- package/docs/sdk/models/shared/accountingcreatesupplierresponseaccountingsupplier.md +29 -0
- package/docs/sdk/models/shared/accountingcreatetransferresponse.md +1 -1
- package/docs/sdk/models/shared/accountingcreatetransferresponseaccountingtransfer.md +25 -0
- package/docs/sdk/models/shared/accountingcreditnote.md +1 -1
- package/docs/sdk/models/shared/accountingcreditnotes.md +7 -7
- package/docs/sdk/models/shared/accountingcustomers.md +7 -7
- package/docs/sdk/models/shared/accountingdirectcost.md +1 -1
- package/docs/sdk/models/shared/accountingdirectcostcontactreference.md +11 -0
- package/docs/sdk/models/shared/accountingdirectcostdatatype.md +11 -0
- package/docs/sdk/models/shared/accountingdirectcosts.md +7 -7
- package/docs/sdk/models/shared/accountingdirectincomes.md +7 -7
- package/docs/sdk/models/shared/accountinginvoice.md +1 -1
- package/docs/sdk/models/shared/accountinginvoicedatatype.md +10 -0
- package/docs/sdk/models/shared/accountinginvoices.md +7 -7
- package/docs/sdk/models/shared/accountingjournalentries.md +7 -7
- package/docs/sdk/models/shared/accountingjournalentry.md +1 -1
- package/docs/sdk/models/shared/accountingjournals.md +7 -7
- package/docs/sdk/models/shared/accountingpayment.md +1 -1
- package/docs/sdk/models/shared/accountingpayments.md +7 -7
- package/docs/sdk/models/shared/accountingsuppliers.md +7 -7
- package/docs/sdk/models/shared/accountingtransfers.md +7 -7
- package/docs/sdk/models/shared/accounts.md +1 -1
- package/docs/sdk/models/shared/accounttransactionline.md +5 -5
- package/docs/sdk/models/shared/accounttransactionlinerecordref.md +11 -0
- package/docs/sdk/models/shared/accounttransactionlinerecordrefdatatype.md +20 -0
- package/docs/sdk/models/shared/bankingaccountbalances.md +7 -7
- package/docs/sdk/models/shared/bankingaccounts.md +7 -7
- package/docs/sdk/models/shared/bankingtransactioncategories.md +7 -7
- package/docs/sdk/models/shared/bankingtransactioncategory.md +3 -1
- package/docs/sdk/models/shared/bankingtransactions.md +7 -7
- package/docs/sdk/models/shared/commercecustomers.md +7 -7
- package/docs/sdk/models/shared/commercedisputes.md +7 -7
- package/docs/sdk/models/shared/commercelocations.md +7 -7
- package/docs/sdk/models/shared/commerceorders.md +7 -7
- package/docs/sdk/models/shared/commercepayment.md +1 -1
- package/docs/sdk/models/shared/commercepaymentmethods.md +7 -7
- package/docs/sdk/models/shared/commercepayments.md +7 -7
- package/docs/sdk/models/shared/commerceproductcategories.md +7 -7
- package/docs/sdk/models/shared/commerceproducts.md +7 -7
- package/docs/sdk/models/shared/commercetransactions.md +7 -7
- package/docs/sdk/models/shared/companies.md +7 -7
- package/docs/sdk/models/shared/company.md +1 -0
- package/docs/sdk/models/shared/companyrequestbody.md +1 -0
- package/docs/sdk/models/shared/connections.md +7 -7
- package/docs/sdk/models/shared/contactref.md +4 -4
- package/docs/sdk/models/shared/contactrefdatatype.md +11 -0
- package/docs/sdk/models/shared/contactreference.md +11 -0
- package/docs/sdk/models/shared/dataintegritydetails.md +7 -7
- package/docs/sdk/models/shared/directcostprototype.md +1 -1
- package/docs/sdk/models/shared/directcostprototypedatatype.md +11 -0
- package/docs/sdk/models/shared/enhancedcashflowtransaction.md +2 -2
- package/docs/sdk/models/shared/enhancedcashflowtransactions.md +5 -5
- package/docs/sdk/models/shared/enhancedinvoicesreport.md +4 -4
- package/docs/sdk/models/shared/errormessage.md +9 -8
- package/docs/sdk/models/shared/errorvalidation.md +11 -0
- package/docs/sdk/models/shared/errorvalidationitem.md +10 -0
- package/docs/sdk/models/shared/groupreference.md +8 -0
- package/docs/sdk/models/shared/invoicelineitem.md +1 -1
- package/docs/sdk/models/shared/items.md +3 -4
- package/docs/sdk/models/shared/journalentryrecordref.md +11 -0
- package/docs/sdk/models/shared/journalentryrecordrefdatatype.md +20 -0
- package/docs/sdk/models/shared/journallinetracking.md +3 -3
- package/docs/sdk/models/shared/pulloperations.md +7 -7
- package/docs/sdk/models/shared/pushoperations.md +7 -7
- package/docs/sdk/models/shared/salesorderreference.md +4 -4
- package/docs/sdk/models/shared/sourcetype.md +2 -0
- package/docs/sdk/models/shared/tracking.md +1 -1
- package/docs/sdk/models/shared/trackingrecordref.md +11 -0
- package/docs/sdk/models/shared/trackingrecordrefdatatype.md +12 -0
- package/docs/sdk/models/shared/withholdingtaxitems.md +9 -0
- package/docs/sdks/accountbalances/README.md +1 -1
- package/docs/sdks/accounts/README.md +2 -2
- package/docs/sdks/accounttransactions/README.md +2 -2
- package/docs/sdks/balancesheet/README.md +2 -2
- package/docs/sdks/bankaccounts/README.md +2 -2
- package/docs/sdks/banktransactions/README.md +2 -2
- package/docs/sdks/billcreditnotes/README.md +2 -2
- package/docs/sdks/billpayments/README.md +2 -2
- package/docs/sdks/bills/README.md +5 -5
- package/docs/sdks/cashflow/README.md +1 -1
- package/docs/sdks/categorizedstatement/README.md +1 -1
- package/docs/sdks/codatlendingaccountingbankdata/README.md +1 -1
- package/docs/sdks/codatlendingaccounts/README.md +2 -2
- package/docs/sdks/codatlendingbankingtransactions/README.md +2 -2
- package/docs/sdks/codatlendingcustomers/README.md +2 -2
- package/docs/sdks/codatlendingdirectcosts/README.md +5 -5
- package/docs/sdks/codatlendingfinancialstatementsaccounts/README.md +2 -2
- package/docs/sdks/codatlendingloanwritebackaccounts/README.md +2 -2
- package/docs/sdks/codatlendingpayments/README.md +4 -3
- package/docs/sdks/codatlendingreports/README.md +2 -2
- package/docs/sdks/codatlendingsalespayments/README.md +2 -2
- package/docs/sdks/codatlendingsuppliers/README.md +26 -7
- package/docs/sdks/codatlendingtransactions/README.md +2 -2
- package/docs/sdks/codatlendingtransfers/README.md +2 -2
- package/docs/sdks/companies/README.md +38 -13
- package/docs/sdks/companyinfo/README.md +2 -2
- package/docs/sdks/connections/README.md +5 -5
- package/docs/sdks/createoperations/README.md +2 -2
- package/docs/sdks/creditnotes/README.md +2 -2
- package/docs/sdks/customers/README.md +5 -5
- package/docs/sdks/dataintegrity/README.md +3 -3
- package/docs/sdks/directcosts/README.md +10 -11
- package/docs/sdks/directincomes/README.md +5 -5
- package/docs/sdks/disputes/README.md +2 -2
- package/docs/sdks/excelreports/README.md +3 -3
- package/docs/sdks/fileupload/README.md +3 -3
- package/docs/sdks/invoices/README.md +7 -7
- package/docs/sdks/journalentries/README.md +2 -2
- package/docs/sdks/journals/README.md +2 -2
- package/docs/sdks/liabilities/README.md +4 -4
- package/docs/sdks/locations/README.md +2 -2
- package/docs/sdks/managedata/README.md +1 -1
- package/docs/sdks/metrics/README.md +3 -3
- package/docs/sdks/orders/README.md +2 -2
- package/docs/sdks/paymentmethods/README.md +2 -2
- package/docs/sdks/payments/README.md +2 -2
- package/docs/sdks/productcategories/README.md +2 -2
- package/docs/sdks/products/README.md +2 -2
- package/docs/sdks/profitandloss/README.md +2 -2
- package/docs/sdks/pulloperations/README.md +2 -2
- package/docs/sdks/refresh/README.md +2 -2
- package/docs/sdks/reports/README.md +4 -4
- package/docs/sdks/suppliers/README.md +5 -5
- package/docs/sdks/transactioncategories/README.md +2 -2
- package/docs/sdks/transfers/README.md +3 -4
- package/package.json +1 -1
- package/docs/sdk/models/shared/accountingdirectcostcontactref.md +0 -11
- package/docs/sdk/models/shared/directcostprototypecontactref.md +0 -11
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `connection`
|
|
9
|
-
| `contentType`
|
|
10
|
-
| `errorMessage`
|
|
11
|
-
| `statusCode`
|
|
12
|
-
| `rawResponse`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8
|
+
| `connection` | [shared.Connection](../../../sdk/models/shared/connection.md) | :heavy_minus_sign: | OK | {"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"} |
|
|
9
|
+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
10
|
+
| `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | |
|
|
11
|
+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
12
|
+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `accountingSupplier`
|
|
9
|
-
| `allowSyncOnPushComplete`
|
|
10
|
-
| `companyId`
|
|
11
|
-
| `connectionId`
|
|
12
|
-
| `timeoutInMinutes`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8
|
+
| `accountingSupplier` | [shared.AccountingSupplier](../../../sdk/models/shared/accountingsupplier.md) | :heavy_minus_sign: | N/A | {"id":"C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F","supplierName":"Kelly's Industrial Supplies","contactName":"Kelly's Industrial Supplies","emailAddress":"sales@kellysupplies.com","phone":"07999 999999","addresses":[{"type":"Billing","line1":"Unit 51","line2":"Bakersfield Industrial Estate","city":"Bakersfield","region":"California","country":"USA","postalcode":"93308"}],"registrationNumber":"string","taxNumber":"string","status":"Unknown","defaultCurrency":"string","metadata":{"isDeleted":true},"supplementalData":{"content":{"property1":{"property1":null,"property2":null},"property2":{"property1":null,"property2":null}}},"modifiedDate":"2022-10-23T00:00:00Z","sourceModifiedDate":"2022-10-23T00:00:00Z"} |
|
|
9
|
+
| `allowSyncOnPushComplete` | *boolean* | :heavy_minus_sign: | Allow a sync upon push completion. | |
|
|
10
|
+
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
|
|
11
|
+
| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
|
|
12
|
+
| `timeoutInMinutes` | *number* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | |
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `accountingAgedCreditorReport`
|
|
9
|
-
| `contentType`
|
|
10
|
-
| `errorMessage`
|
|
11
|
-
| `statusCode`
|
|
12
|
-
| `rawResponse`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8
|
+
| `accountingAgedCreditorReport` | [shared.AccountingAgedCreditorReport](../../../sdk/models/shared/accountingagedcreditorreport.md) | :heavy_minus_sign: | OK | {"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}]}]}]}]} |
|
|
9
|
+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
10
|
+
| `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | |
|
|
11
|
+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
12
|
+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `accountingAgedDebtorReport`
|
|
9
|
-
| `contentType`
|
|
10
|
-
| `errorMessage`
|
|
11
|
-
| `statusCode`
|
|
12
|
-
| `rawResponse`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8
|
+
| `accountingAgedDebtorReport` | [shared.AccountingAgedDebtorReport](../../../sdk/models/shared/accountingageddebtorreport.md) | :heavy_minus_sign: | OK | {"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}]}]}]}]} |
|
|
9
|
+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
10
|
+
| `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | |
|
|
11
|
+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
12
|
+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `accountingBillCreditNote`
|
|
9
|
-
| `contentType`
|
|
10
|
-
| `errorMessage`
|
|
11
|
-
| `statusCode`
|
|
12
|
-
| `rawResponse`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8
|
+
| `accountingBillCreditNote` | [shared.AccountingBillCreditNote](../../../sdk/models/shared/accountingbillcreditnote.md) | :heavy_minus_sign: | Success | {"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"}]},{"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"}} |
|
|
9
|
+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
10
|
+
| `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | |
|
|
11
|
+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
12
|
+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `accountingBillPayment`
|
|
9
|
-
| `contentType`
|
|
10
|
-
| `errorMessage`
|
|
11
|
-
| `statusCode`
|
|
12
|
-
| `rawResponse`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
8
|
+
| `accountingBillPayment` | [shared.AccountingBillPayment](../../../sdk/models/shared/accountingbillpayment.md) | :heavy_minus_sign: | Success | {"totalAmount":1000,"lines":[{"amount":1000,"links":[{"type":"Bill","id":"x","amount":-1000}]}]} |
|
|
9
|
+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
10
|
+
| `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | |
|
|
11
|
+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
12
|
+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Fields
|
|
5
5
|
|
|
6
|
-
| Field
|
|
7
|
-
|
|
|
8
|
-
| `accountingCreditNote`
|
|
9
|
-
| `contentType`
|
|
10
|
-
| `errorMessage`
|
|
11
|
-
| `statusCode`
|
|
12
|
-
| `rawResponse`
|
|
6
|
+
| Field | Type | Required | Description | Example |
|
|
7
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
8
|
+
| `accountingCreditNote` | [shared.AccountingCreditNote](../../../sdk/models/shared/accountingcreditnote.md) | :heavy_minus_sign: | Success | [{"allocatedOnDate":null,"creditNoteNumber":"5239277","currency":"USD","currencyRate":null,"customerRef":{"companyName":"Tool Hire Company","id":"b5511228-b9ef-4713-91b1-ad2cf60eadb1"},"discountPercentage":0,"id":"0316bd24-8a01-4a3a-a0e5-a73f14ebcbec","issueDate":"2018-03-28T21:28:58.249Z","lineItems":[{"accountRef":{"id":"3f267b10-757d-44c0-bef9-20f70cc8fbe3","name":null},"description":"Anvil10000Lb","discountAmount":0,"discountPercentage":null,"itemRef":{"id":"1","name":null},"quantity":10,"subTotal":500,"taxAmount":50,"taxRateRef":{"id":"6c88aff3-7cb9-4980-a3d3-443e72e02498","name":null},"totalAmount":550,"unitAmount":50}],"modifiedDate":null,"note":"More information available on request.","paymentAllocations":[],"remainingCredit":550,"sourceModifiedDate":null,"status":"Submitted","subTotal":0,"totalAmount":550,"totalDiscount":0,"totalTaxAmount":0}] |
|
|
9
|
+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
|
|
10
|
+
| `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | |
|
|
11
|
+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
|
|
12
|
+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
|