Skip to main content
POST
/
coa
/
api
/
v1
/
invoice
/
{invoice_id}
/
calculate-payment
Calculate Invoice Payment
curl --request POST \
  --url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/calculate-payment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactions": [
    {
      "transaction_id": 123,
      "amount": 0,
      "posted_at": "2023-12-25"
    }
  ],
  "credit_memos": [
    {
      "credit_memo_id": 123,
      "amount": 0,
      "posted_at": "2023-12-25"
    }
  ],
  "empty_transactions": [
    {
      "amount": 0,
      "payment_date": "2023-12-25"
    }
  ]
}
'
{
  "total_due": 0,
  "applied_payments": 0,
  "applied_credits": 0,
  "term_discounts": 0,
  "remaining_due": 0
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

invoice_id
integer
required

ID of the invoice

Body

transactions
object[]
credit_memos
object[]
empty_transactions
object[]

Response

total_due
number
required
Required range: -1000000000000000000 < x < 1000000000000000000
applied_payments
number
required
Required range: -1000000000000000000 < x < 1000000000000000000
applied_credits
number
required
Required range: -1000000000000000000 < x < 1000000000000000000
term_discounts
number
required
Required range: -1000000000000000000 < x < 1000000000000000000
remaining_due
number
required
Required range: -1000000000000000000 < x < 1000000000000000000