COcodatio
Bills

Delete bill

Changed on

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

Bills are itemized records of goods received or services provided to the SMB.

Process

  1. Pass the {billId} to the Delete bill 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 (advised),
    2. Push operation status endpoint.

    A Success status indicates that the bill object was deleted from the accounting software.

  3. (Optional) Check that the bill was deleted from the accounting software.

Effect on related objects

Be aware that deleting a bill from an accounting software might cause related objects to be modified. For example, if you delete a paid bill in QuickBooks Online or QuickBooks Desktop, the bill is deleted but the bill payment against that bill is not. The bill payment is converted to a payment on account.

Integration specifics

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

IntegrationSoft DeleteDetails
QuickBooks OnlineNo-
QuickBooks DesktopNo-
Oracle NetSuiteNoWhen deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first.
Sage IntacctNoWhen deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first.
XeroNoDraft bills will be deleted. Open bills will be voided instead of deleted since Xero only allows voiding a bill once it's been posted. When deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first.

Supported Integrations

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

delete/companies/{companyId}/connections/{connectionId}/push/bills/{billId}

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/bills/{billId}
  • Auth
    API key in header Authorization

Response

OK

changesPushOperationChange[] nullable(unresolved $ref)

Contains a single entry that communicates which record has changed and the manner in which it changed.

dataTypeDataType (unresolved $ref)
companyIdSchema required(unresolved $ref)
pushOperationKeystring 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.

dataConnectionKeySchema required(unresolved $ref)
requestedOnUtcCreated required(unresolved $ref)
completedOnUtcCreated (unresolved $ref)
timeoutInMinutesinteger nullable

Number of minutes the push operation must complete within before it times out.

timeoutInSecondsinteger nullable

Number of seconds the push operation must complete within before it times out.

statusPushOperationStatus required(unresolved $ref)
errorMessagestring nullable

A message about the error.

validationValidation (unresolved $ref)
statusCodeinteger required

Push status code.

Changes

  • v14107d26779c6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status