Skip to content

Commit

Permalink
Merge pull request #1296 from codatio/chore/push-pull-rename
Browse files Browse the repository at this point in the history
Replace push/pull with new terminology
  • Loading branch information
pzaichkina authored Aug 16, 2024
2 parents 6907f50 + 59b10c5 commit ae673b8
Show file tree
Hide file tree
Showing 185 changed files with 666 additions and 668 deletions.
10 changes: 5 additions & 5 deletions blog/220817-qbd-refs.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: "Completed 2022-10-10: QuickBooks Desktop: Only one of account ref or item ref will be allowed when pushing bills"
title: "Completed 2022-10-10: QuickBooks Desktop: Only one of account ref or item ref will be allowed when writing bills"
date: "2022-08-17"
tags: ["Deprecation", "Completed"]
draft: false
authors: mcclowes
---

On January 10, 2023, we will change the Push validation for individual lines on Bills and Bill credit notes to allow only one of either accountRef or itemRef per line item.
On January 10, 2023, we will change the Write validation for individual lines on Bills and Bill credit notes to allow only one of either accountRef or itemRef per line item.

<!--truncate-->

This will apply to bills and bill credit notes pushed to QuickBooks Desktop only.
This will apply to bills and bill credit notes written to QuickBooks Desktop only.

Action required
If your code attempts to push Bills or Bill credit note to Codat with both an accountRef and an itemRef, you will need to update this to Push only one or the other.
If your code attempts to write Bills or Bill credit note to Codat with both an accountRef and an itemRef, you will need to update this to write only one or the other.

Expected impact if no action is taken
Any code that attempts to push Bills or Bill credit note to Codat with both an accountRef and an itemRef after January 10, 2023 will result in an error.
Any code that attempts to write Bills or Bill credit note to Codat with both an accountRef and an itemRef after January 10, 2023 will result in an error.

You can get ahead of this change by enabling it now in the Portal. Learn how to do that here, or read our change policy here.
2 changes: 1 addition & 1 deletion blog/220817-sage-50-soft-deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ No change is expected to other (not deleted) data.

### Additional information

Deleted Payments on Account pulled as Payments or Bill Payments before this change will no longer be returned when querying Payments and Bill Payments from Codat.
Deleted Payments on Account read as Payments or Bill Payments before this change will no longer be returned when querying Payments and Bill Payments from Codat.

:::note Get ahead

Expand Down
10 changes: 5 additions & 5 deletions blog/220826-wbo-invoice-push.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: "Completed 2023-01-10: QuickBooks Online - change to invoice push validation"
title: "Completed 2023-01-10: QuickBooks Online - change to invoice write validation"
date: "2022-08-26"
tags: ["Deprecation", "Completed"]
draft: false
authors: mcclowes
---

On January 10, 2023, we will be adding new validations when pushing invoices to QuickBooks Online.
On January 10, 2023, we will be adding new validations when writing invoices to QuickBooks Online.

<!--truncate-->

This means that when pushing an invoice:
This means that when writing an invoice:

The TotalAmount will need to equal the sum of line items, discounts, and tax.
The SubTotal will need to equal the sum of line items and discounts.
Action required
Please check that your code when pushing invoices complies with these rules. If not, you need to change the code to comply. The code must adhere to the following rules:
Please check that your code when writing invoices complies with these rules. If not, you need to change the code to comply. The code must adhere to the following rules:

TotalAmount
- TotalAmount should be equal to the sum of line items minus the discount percentage plus tax.
Expand All @@ -29,6 +29,6 @@ SubTotal

#### Expected result if no action is taken

The push endpoint will return a validation error message and the push operation will fail.
The write endpoint will return a validation error message and the write operation will fail.

You can get ahead of this change by enabling it now in the Portal.
4 changes: 2 additions & 2 deletions blog/220926-freshbooks-expenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Action required
If you require expense data from Freshbooks, use the Codat Direct costs datatype instead.

Expected impact if no action is taken
Pulling Bills and Bill payments will no longer include Freshbooks expense data, so you may not see the data you expect.
Reading Bills and Bill payments will no longer include Freshbooks expense data, so you may not see the data you expect.

### Additional information

Pulling Bills and Bill payments for a Company with a pre-existing completed data sync (for these datatypes) will result in any pre-existing Bills and Bill payments that represent Freshbooks expenses being voided (Bills) or deleted (Bill payments).
Reading Bills and Bill payments for a Company with a pre-existing completed data sync (for these datatypes) will result in any pre-existing Bills and Bill payments that represent Freshbooks expenses being voided (Bills) or deleted (Bill payments).

You can get ahead of this change by enabling it now in the Portal. Learn how to do that [here](https://docs.codat.io/configure/portal/developers), or read our [change policy](https://docs.codat.io/using-the-api/change-policy).
4 changes: 2 additions & 2 deletions blog/221003-quickbooks-online.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Action required
If you require purchase data from QuickBooks Online, use the Codat Direct costs datatype instead.

Expected impact if no action is taken
Pulling Bill Credit notes, Bills and Bill payments will no longer include QuickBooks Online purchase data, so you may not see the data you expect.
Reading Bill Credit notes, Bills and Bill payments will no longer include QuickBooks Online purchase data, so you may not see the data you expect.

## Additional information

Pulling Bills and Bill payments for a Company with a pre-existing completed data sync (for these datatypes) will result in any pre-existing Bills and Bill payments that represent QuickBooks Online purchases being voided (Bills) or deleted (Bill payments).
Reading Bills and Bill payments for a Company with a pre-existing completed data sync (for these datatypes) will result in any pre-existing Bills and Bill payments that represent QuickBooks Online purchases being voided (Bills) or deleted (Bill payments).

:::note Get ahead

Expand Down
4 changes: 2 additions & 2 deletions blog/221023-push-history.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Company data push history now available via the Portal
title: Company data write history now available via the Portal
date: "2022-10-23"
tags: ["Portal"]
draft: false
authors: mcclowes
---

You can now view a table of data pushed for each company.
You can now view a table of data written for each company.

<!--truncate-->

Expand Down
4 changes: 2 additions & 2 deletions blog/230203-weekly-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Sync for Expenses is an API and a set of supporting tools. It has been built to

### Accounting API

- **New:** Support for pushing Direct Costs to FreeAgent
- **New:** Push payment/billPayment on Xero with a line link type paymentOnAccount
- **New:** Support for writing Direct Costs to FreeAgent
- **New:** Write payment/billPayment on Xero with a line link type paymentOnAccount
- **New:** Migrate FreeAgent tokens via PUT `/companies/{companyId}/connections/{connectionId}/authorization`

### Portal
Expand Down
2 changes: 1 addition & 1 deletion blog/230218-weekly-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ We'd love to hear your opinions, so please let us know how you're finding them i

### Accounting API

- **New:** We've added support for pushing Direct Incomes on FreeAgent
- **New:** We've added support for writing Direct Incomes on FreeAgent

### Portal

Expand Down
4 changes: 2 additions & 2 deletions blog/230404-product-update-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ We've improved our data type coverage for a number of integrations.

#### QuickBooks Online

- Customer tracking on Expense lines (Direct Cost - Pull and Push)
- Customer tracking on Expense lines (Direct Cost - Read and Write)
- Create `Payment` on Account refunds

#### MYOB
Expand All @@ -28,7 +28,7 @@ We've improved our data type coverage for a number of integrations.

#### FreeAgent

- We've added support for pushing Direct Cost attachments
- We've added support for writing Direct Cost attachments

## Deprecations

Expand Down
2 changes: 1 addition & 1 deletion blog/230710-deprecation-qbd-direct-incomes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ On July 10, 2023, Codat will change the mappings for the Direct incomes data typ

After this change, the `id` property in Direct incomes will be mapped as `"Deposit ID - Transaction line ID"`.

This changes will ensure that the `id` parameter is unique when Direct incomes are pulled to QuickBooks Desktop via the connector.
This changes will ensure that the `id` parameter is unique when Direct incomes are read to QuickBooks Desktop via the connector.
8 changes: 4 additions & 4 deletions blog/231002-stop-returning-data-on-push.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Diff from "@components/Diff"

On **January 10, 2024**, we will deprecate the `data` field that is currently returned in the response and `/push` endpoints when creating or updating entities.

Pushed data will also no longer be stored within Codat, and a refresh of data will be required for Codat to reflect new or updated records.
Written data will also no longer be stored within Codat, and a refresh of data will be required for Codat to reflect new or updated records.

<!--truncate-->

Expand Down Expand Up @@ -101,14 +101,14 @@ You can see a before and after examples of responses below:

## Action required​

If you currently make use of any properties in the `data` object of the push operation response, you will need to use the `changes.recordRef` object instead.
If you currently make use of any properties in the `data` object of the write operation response, you will need to use the `changes.recordRef` object instead.

1. Use `changes.recordRef` to retrieve the record `datatype` and `id`.
2. Initiate a sync for the given data type or wait until the next scheduled sync.
3. After the sync is complete, make a `GET` call to the relevant endpoint to retrieve the full record if needed.

## Expected impact if no action is taken​

As of January 10, 2024, you will no longer be able to use the `data` object on the push operation responses or `/push` endpoints.
As of January 10, 2024, you will no longer be able to use the `data` object on the write operation responses or `/push` endpoints.

You will not be able to use the returned `id` to access the records you have pushed within Codat until you've (refreshed that company's data](/using-the-api/queueing-data-syncs) for the given data type.
You will not be able to use the returned `id` to access the records you have written within Codat until you've (refreshed that company's data](/using-the-api/queueing-data-syncs) for the given data type.
2 changes: 1 addition & 1 deletion blog/231003-deprecation-accounting-deleted-records.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ On **January 10, 2024**, we will change how we handle data deleted by users in a

<!--truncate-->

When data is deleted by a user in the SMB's accounting software between two successive data pulls, Codat sets the `metaData.isDeleted` property to `true`. This ensures there is consistency in records returned between successive data pulls and clearly identifies records deleted by a user.
When data is deleted by a user in the SMB's accounting software between two successive data reads, Codat sets the `metaData.isDeleted` property to `true`. This ensures there is consistency in records returned between successive data reads and clearly identifies records deleted by a user.

**Today, for some data types, Codat also updates the `status` property of the deleted record. **

Expand Down
2 changes: 1 addition & 1 deletion blog/231005-fetching-is-paused.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tags: ["Product", "Update"]
authors: mcclowes
---

We recently released some important infrastructure changes to improve reliability when pulling data from third party platforms. It also means fewer API calls to third parties, so you're less likely to encounter rate limits.
We recently released some important infrastructure changes to improve reliability when reading data from third party platforms. It also means fewer API calls to third parties, so you're less likely to encounter rate limits.

<!--truncate-->

Expand Down
4 changes: 2 additions & 2 deletions blog/231010-deprecation-onprem-erp-premium.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ You can either [get in touch here](https://www.codat.io/plans/#get-in-touch) or
From the 10th October, 2023, start-up & free plan clients will no longer be able to use these integrations.

- **New connections** - Your customers won't be able to authorize access to these platforms. Additionally, they will no longer appear in Link.
- **New data synchronisations** - Existing connections to these platforms won't work, and new data won't be able to be pulled from or pushed to these source.
- **New data synchronisations** - Existing connections to these platforms won't work, and new data won't be able to be read from or written to these sources.
- **Configuration** - You'll no longer be able to enable or amend the integration. You'll see the below message:

![Premium flag on integrations in the Portal](/img/updates/erp-deprecation.png)

**Any existing pulled data will not be impacted.** You'll still have access to any company data you've already pulled, you just won't be able to refresh that data.
**Any existing read data will not be impacted.** You'll still have access to any company data you've already read, you just won't be able to refresh that data.
2 changes: 1 addition & 1 deletion blog/240220-qbd-sync-for-expenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Sync for Expenses now allows you to solve not only the complexities of accountin

In this release, you can access:

- **A standard model for pushing expenses to QuickBooks Desktop.** Sync for Expenses’ standardized model consolidates the full end-to-end expense journey, considering the endpoints and logic required to accurately sync an expense in QuickBooks Desktop, including transaction type, multiple currencies and tax.
- **A standard model for writing expenses to QuickBooks Desktop.** Sync for Expenses’ standardized model consolidates the full end-to-end expense journey, considering the endpoints and logic required to accurately sync an expense in QuickBooks Desktop, including transaction type, multiple currencies and tax.

- **Out-the-box connection UI to get customers syncing in a few steps.** Codat enables integrations via the Intuit Web Connector, which starts up automatically after a system reboot and then updates silently in the background. There's no action needed from your users to keep data flowing.

Expand Down
4 changes: 2 additions & 2 deletions blog/240320-deprecation-ruleId.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ The `RuleId` property will be deprecated in the following webhook rule schemas:
- [Data sync completed](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#data-sync-completed)
- [Dataset data changed](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#dataset-data-changed)
- [Dataset status has changed to an error state](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#dataset-status-has-changed-to-an-error-state)
- [Push operation status has changed](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#push-operation-status-has-changed)
- [Push operation has timed out](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#push-operation-has-timed-out)
- [Write operation status has changed](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#push-operation-status-has-changed)
- [Write operation has timed out](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#push-operation-has-timed-out)
- [Account categories updated](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#account-categories-updated)
- [Sync Connection Deleted](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#sync-connection-deleted)
- [Expenses sync completed](https://docs.codat.io/using-the-api/webhooks/legacy/core-rules-types#expenses-sync-completed)
Expand Down
2 changes: 1 addition & 1 deletion docs/auth-flow/optimize/connection-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import TabItem from "@theme/TabItem";

Give your customers the ability to manage the access permissions they have given you by using our **Connections SDK** in your front end. This is key from a regulatory perspective, builds trust between you and your customer, and is required by some accounting software (e.g. Xero).

![An image of three in-app screenshots of the Connections UI. The first picture displays a list of three existing connections to Xero, Square, and Commerce Sandbox. The second image shows the entry for the Square connection with dates the authorization was given and recent data pull dates. It also lists the option to disconnect the connection. The final image displays a confirmation of the disconnection.](/img/auth-flow/auth-flow-connection-ui-examples.png)
![An image of three in-app screenshots of the Connections UI. The first picture displays a list of three existing connections to Xero, Square, and Commerce Sandbox. The second image shows the entry for the Square connection with dates the authorization was given and recent data read dates. It also lists the option to disconnect the connection. The final image displays a confirmation of the disconnection.](/img/auth-flow/auth-flow-connection-ui-examples.png)

### Functionality

Expand Down
2 changes: 1 addition & 1 deletion docs/auth-flow/optimize/maximize-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Sharing financial data manually will not be the norm in years to come – let th
At the first point of engagement, data is manually extracted in the format that it is required which means they don’t have to download from different systems and format, they can spend time focused on their business and making that successful.
Better rates - if you save money from the initial onboarding/ongoing servicing/reduction in bad debts, can you pass some of that benefit on to the customer?
The link process enables small businesses to be serviced at competitive rates; using manual processes this segment is not profitable to service
Consider using Codat’s push functionality to input lending transactions into the accounting software on their behalf, reducing the manual work for your customer even further
Consider using Codat’s write functionality to input lending transactions into the accounting software on their behalf, reducing the manual work for your customer even further
Suggested language

Two examples of messaging to build into your flow or share with your clients:
Expand Down
6 changes: 3 additions & 3 deletions docs/bank-feeds/guides/bank-feeds-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,13 +484,13 @@ if credentialsRes.BankAccountCredentials != nil {

When completing the authorization in QBO Banking, your user chooses the bank accounts they want to connect. At the same time, they also choose a `feed_start_date` value that is then used to limit the load of historic transactions to seven days.

Once this is complete, you can sync transactions between the bank and Codat. QBO will then poll Codat periodically to pull these transactions to their bank feed.
Once this is complete, you can sync transactions between the bank and Codat. QBO will then poll Codat periodically to read these transactions to their bank feed.

### Sync bank feeds bank transactions

:::tip Bank transactions guidelines

- You can push historic (back-dated) transactions that are up to seven days old based on the `feed_start_date`, as chosen by the SMB user in the QBO UI.
- You can write historic (back-dated) transactions that are up to seven days old based on the `feed_start_date`, as chosen by the SMB user in the QBO UI.
- Syncing future-dated transactions to QBO is not supported.
- You can only sync bank transactions from one connected account at a time.
- Bank transactions must be synced in chronological order (from earliest to latest) based on the `cleared_on_date`.
Expand Down Expand Up @@ -652,7 +652,7 @@ res, err := bankFeedsClient.Transactions.Create(ctx, operations.CreateBankTransa

</Tabs>

Repeat the request for the remainder of the SMB user's source bank accounts. Keep the bank transactions in Codat up to date, as QBO polls Codat periodically to pull these transactions to their bank feeds.
Repeat the request for the remainder of the SMB user's source bank accounts. Keep the bank transactions in Codat up to date, as QBO polls Codat periodically to read these transactions to their bank feeds.

:::tip Recap

Expand Down
4 changes: 2 additions & 2 deletions docs/bank-feeds/integrations/qbo/mapping.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Map accounts in QuickBooks Online"
description: "Push bank transaction data into your customers' accounting software with an automated feed"
description: "Write bank transaction data into your customers' accounting software with an automated feed"
sidebar_label: Map accounts
displayed_sidebar: bankfeeds
hide_description: true
Expand Down Expand Up @@ -177,4 +177,4 @@ QuickBooks online only supports retrieval of transactions **up to 90 days old**,
---
## Read next

[Pushing transactions](/bank-feeds/pushing-transactions).
[Writing transactions](/bank-feeds/pushing-transactions).
Loading

0 comments on commit ae673b8

Please sign in to comment.