Remove payment from invoice

DELETE /api/v1/invoices/{invoice_id}/payments/{payment_id}

Un-link a payment record from an invoice and recalculate status.

Operation ID: delete_invoice_payment_api_v1_invoices__invoice_id__payments__payment_id__delete · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

invoice_id string · uuid required
payment_id string · uuid required

Responses

200 Successful Response

Schema: SuccessResponseModel

success boolean
message string required
code string required
data object
id string
task_id string
total integer
succeeded integer
failed integer
errors array · string

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

DELETE /api/v1/invoices/{invoice_id}/payments/{payment_id}

bash

curl -X DELETE 'https://api.ondayzero.com/api/v1/invoices/{invoice_id}/payments/{payment_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/invoices/{invoice_id}/payments/{payment_id}', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.delete("https://api.ondayzero.com/api/v1/invoices/{invoice_id}/payments/{payment_id}", headers=headers)
data = response.json()