Creates an outbound payment.

POST /accounting/outbound-payments

Group: Accounting › Outbound Payments · Operation ID: createOutboundPayment

The response contains only the new payment's id. Read the record with GET accounting/outbound-payments/:id if you need its stored state, where outboundPaymentNumber appears once assigned. This records a payment and does not execute one. The payment is created with status manuallyRecorded, and initiating a bank payment is not part of this version. Every item pays one document, and documentType names the one kind of document the whole payment pays. Every document must be payable and all in one currency, or the call fails with DOCUMENT_NOT_PAYABLE or DOCUMENT_CURRENCY_MISMATCH before anything is written.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createOutboundPaymentInput.

Field Type Required Description
accountId string yes The bank or cash account the payment is made from. See id on GET accounting/accounts/:id.
entityId string yes The legal entity the payment is posted under. See id on GET base/entities.
paymentDate string (date) yes The date the payment is made. Use format YYYY-MM-DD.
paymentCurrency string yes The currency of the payment. Format ISO 4217, for example 'USD'. Governs each item's amount unless the item names its own currency.
documentType string yes The one kind of document every item pays, either 'VendorBillHeaderBase' or 'ExpenseReportBase'. A payment pays one kind, not a mixture.
singlePayment boolean no Whether this is a single payment rather than a batch.
commonDescription string no A description applied to the payment as a whole.
skipJournalEntry boolean no Whether to skip journal-entry creation for this payment. Defaults to false.
externalUrl string no A link back to the payment in the upstream system.
origin string no The source system this payment came from.
senderAccountId string no A bank account identifier for the sender, supplied by an integration. It is free-form text, not a reference to an account record.
actualExchangeRate string (decimal) no The exchange rate the bank actually applied, as a decimal.
systemExchangeRate string (decimal) no The exchange rate the system derived, as a decimal.
paymentItems array of object yes The documents this payment settles. At least one is required.
paymentItems[].documentId string yes The vendor bill or expense report being paid, of the kind named by documentType. See id on GET accounting/vendor-bills/:id or GET accounting/expense-reports/:id.
paymentItems[].entityId string yes The legal entity the document is posted under. See id on GET base/entities.
paymentItems[].amount string (decimal) yes The amount applied to this document, as a decimal.
paymentItems[].currency string no The currency for this item. Format ISO 4217, for example 'USD'. Omit to use the payment's currency.
paymentItems[].description string yes What this item pays for. Required.
attachments array of object no Files to attach to the payment. Each names an already-uploaded file by its id.
attachments[].fileName string yes The display name of the attached file.
attachments[].fileId string yes The identifier of the already-uploaded file. There is no endpoint for it.

Example:

{
  "accountId": "6d1e4b27-8a90-4c31-b5f2-7e8a9c0d1b23",
  "entityId": "8f2c1d40-5a6b-4c7d-9e80-1f2a3b4c5d6e",
  "paymentDate": "2026-08-27",
  "paymentCurrency": "USD",
  "documentType": "VendorBillHeaderBase",
  "singlePayment": true,
  "commonDescription": "<commonDescription>",
  "skipJournalEntry": true,
  "externalUrl": "<externalUrl>",
  "origin": "<origin>",
  "senderAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "actualExchangeRate": "19.99",
  "systemExchangeRate": "19.99",
  "paymentItems": [
    {
      "documentId": "c41d0b58-2e97-4f6a-8d13-7b5e9c204af6",
      "entityId": "8f2c1d40-5a6b-4c7d-9e80-1f2a3b4c5d6e",
      "amount": "1200.00",
      "description": "Invoice 5512"
    }
  ],
  "attachments": [
    {
      "fileName": "<fileName>",
      "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Response

200 Success

Under data (createOutboundPaymentOutput):

Field Type Required Description
id string yes The unique identifier for the created payment.

Response headers

Errors

Code Status
REFERENCE_NOT_FOUND 400
DOCUMENT_NOT_PAYABLE 400
PAYMENT_AMOUNT_EXCEEDS_OPEN_AMOUNT 400
DOCUMENT_CURRENCY_MISMATCH 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses