Get Default Payment Amount

Get the default payment amount for an invoice based on when payment is posted.

If the invoice has discount terms and the posted date is within the discount period, the discounted amount is returned. Otherwise, the full amount is returned.

POST /coa/api/v1/invoice/{invoice_id}/default-payment

Get Default Payment Amount

cURL

curl --request POST \
  --url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/default-payment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "posted_at": "2023-12-25",
  "transaction_amount": 0
}
'

200

{
  "default_payment_amount": 0,
  "payment_term_discount_note": "<string>"
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

invoice_id · integer · required

ID of the invoice

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

posted_at · string<date> · required

Date when payment would be posted

transaction_amount · number<double> | null

Optional transaction amount

Required range: -1000000000000000000 < x < 1000000000000000000

Response

200

application/json

default_payment_amount · number<double> · required

Required range: -1000000000000000000 < x < 1000000000000000000

payment_term_discount_note · string | null