---
title: "Delete bill payment"
method: DELETE
path: "/companies/{companyId}/connections/{connectionId}/push/billPayments/{billPaymentId}"
tags: ["Bill payments"]
---

# Delete bill payment

`DELETE /companies/{companyId}/connections/{connectionId}/push/billPayments/{billPaymentId}`

## Request

- Base URL: `https://api.codat.io`
- URL: `https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/billPayments/{billPaymentId}`
- Auth: API key in header `Authorization`

The *Delete bill payment* endpoint allows you to delete a specified bill payment from an accounting software.

[Bill payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) are an allocation of money within any Accounts Payable account.

### Process
1. Pass the `{billPaymentId}` to the *Delete bill payment* endpoint and store the `pushOperationKey` returned.
2. Check the status of the delete operation by checking the status of the push operation either via
   1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),
   2. [Push operation status endpoint](https://docs.codat.io/sync-for-payables-api#/operations/get-push-operation).

   A `Success` status indicates that the bill payment object was deleted from the accounting software.
3. (Optional) Check that the bill payment was deleted from the accounting software.

### Effect on related objects
Be aware that deleting a bill payment from an accounting software might cause related objects to be modified.

## Integration specifics
Integrations that support soft delete do not permanently delete the object in the accounting software.

| Integration | Soft Delete | Details |
|-------------|-------------|---------|
| QuickBooks Online  | No  | -
| QuickBooks Desktop | No  | -
| Oracle NetSuite    | No  | See [here](/integrations/accounting/netsuite/accounting-netsuite-how-deleting-bill-payments-works) to learn more.
| Xero               | Yes | -     
| Sage Intacct       | No  | Some bill payments in Sage Intacct can only be deleted, whilst others can only be voided. Codat have applied logic to handle this complexity. 

> **Supported integrations**
>
> This functionality is currently supported for our QuickBooks Online, QuickBooks Desktop, Oracle NetSuite, Xero and Sage Intacct integrations.

## Response `200`

OK

- PushOperation
  - `changes` PushOperationChange[], nullable: Contains a single entry that communicates which record has changed and the manner in which it changed. (unresolved $ref)
  - `dataType` DataType (unresolved $ref)
  - `companyId` Schema, required (unresolved $ref)
  - `pushOperationKey` string, uuid, required: 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` Schema, required (unresolved $ref)
  - `requestedOnUtc` Created, required (unresolved $ref)
  - `completedOnUtc` Created (unresolved $ref)
  - `timeoutInMinutes` integer, nullable: Number of minutes the push operation must complete within before it times out.
  - `timeoutInSeconds` integer, nullable: Number of seconds the push operation must complete within before it times out.
  - `status` PushOperationStatus, required (unresolved $ref)
  - `errorMessage` string, nullable: A message about the error.
  - `validation` Validation (unresolved $ref)
  - `statusCode` integer, required: Push status code.

## Other responses

- `401`: Your API request was not properly authorized.
- `402`: 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.
- `403`: You are using an outdated API key or a key not associated with that resource.
- `404`: 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.
- `429`: Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500`: There is a problem with our server. Please try again later.
- `503`: The Codat API is temporarily offline for maintenance. Please try again later.

## Changes

- **2024-02-13** (v1) `4107d26779c6`: 7 info
  - added the optional property `validation` to the response with the `401` status
  - added the optional property `validation` to the response with the `402` status
  - added the optional property `validation` to the response with the `403` status
  - added the optional property `validation` to the response with the `404` status
  - …3 more

[Operation history](https://skmtc.dev/codatio/apis/sync-for-payables/changes/companies/:companyId/connections/:connectionId/push/billPayments/:billPaymentId/delete.md)

---

[API](https://skmtc.dev/codatio/apis/sync-for-payables.md) - [All operations](https://skmtc.dev/codatio/apis/sync-for-payables/llms.txt) - [OpenAPI document](https://skmtc.dev/codatio/apis/sync-for-payables/revisions/06163dffa75f?raw)