KAkantata
External Payments

Creating a new External Payment

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.

post/external_payments

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • invoice (Invoice) - The invoice (if any) for which the external payment was created.
  • user (User) - The user who created the external payment.
  • workspace (Workspace) - The project in which the external payment was created.

Request body

Response

External Payment has been created.

countinteger
external_paymentsobject
usersobject
workspacesobject
invoicesobject

Changes

No recorded changes to this operation across all 1 revision of this API.