COcodatio
Bill payments

Delete bill payment

Changed on

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

Bill payments 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 (advised),
    2. Push operation status endpoint.

    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.

IntegrationSoft DeleteDetails
QuickBooks OnlineNo-
QuickBooks DesktopNo-
Oracle NetSuiteNoSee here to learn more.
XeroYes-
Sage IntacctNoSome 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.

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

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