# External Payments

An external payment is a manual record of a payment made outside of Kantata OX.  An external payment can
be applied to an invoice, or just recorded directly to a project.

## Fetching a list of External Payments

 - [GET /external_payments](https://developer.kantata.com/kantata/specification/external-payments/get-external-payments.md): The external payments currently visible to the user that is logged-in.


This endpoint returns structured External Payment objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the external_payments top-level JSON key.
Please see our Response Format section for more information.

## Creating a new External Payment

 - [POST /external_payments](https://developer.kantata.com/kantata/specification/external-payments/create-external-payment.md): Creates an external payment for the specified project or invoice. If an invoice ID is provided, a
payment is only created for that invoice when it's a single project invoice and in a non-draft pending state.


This endpoint returns structured External Payment objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the external_payments top-level JSON key.
Please see our Response Format section for more information.

## Fetching a single External Payment

 - [GET /external_payments/{id}](https://developer.kantata.com/kantata/specification/external-payments/get-external-payment.md): This endpoint returns structured External Payment objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the external_payments top-level JSON key.
Please see our Response Format section for more information.

## Deleting an existing External Payment

 - [DELETE /external_payments/{id}](https://developer.kantata.com/kantata/specification/external-payments/delete-external-payment.md): The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.