Invoices

Create an invoice payment

Creates a payment or payout against the specified invoice.

post/invoices/{invoice_id}/invoice_payments

Request

  • Base URL: https://api.streamtime.net/v2
  • URL: https://api.streamtime.net/v2/invoices/{invoice_id}/invoice_payments
  • Auth: HTTP bearer

Path parameters

invoice_idinteger required

Query parameters

paymentAccountIdstring

Payment account ID (required for non-external invoices)

Request body

idinteger

Payment ID

paymentDatestring date

Date the payment was made

notesstring nullable

Notes for the payment

amountPaidIncTaxnumber float nullable

Payment amount inclusive of any taxes

invoiceIdinteger

The ID of the invoice this payment belongs to

Example request

{
  "id": 555,
  "paymentDate": "2025-01-02",
  "notes": "Ref #1255",
  "amountPaidIncTax": 22000,
  "invoiceId": 3456
}

Response

Invoice payment created.

idinteger

Payment ID

paymentDatestring date

Date the payment was made

notesstring nullable

Notes for the payment

amountPaidIncTaxnumber float nullable

Payment amount inclusive of any taxes

invoiceIdinteger

The ID of the invoice this payment belongs to

Example response

{
  "id": 555,
  "paymentDate": "2025-01-02",
  "notes": "Ref #1255",
  "amountPaidIncTax": 22000,
  "invoiceId": 3456
}

Changes

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