Skip to main content
Solved

Apply Retainage via API

  • March 11, 2026
  • 2 replies
  • 64 views

I’m looking for instructions or an example on how to set the “Apply Retainage” checkbox on an AR Invoice via an API.  It’s very easy to do in the UI and works exactly how we’d like.  We’ve enabled the Retainage features, and extended the Invoice endpoint to include RetainageApply and RetainagePct fields; however, they’re not not being triggered when sent as “:true” etc. through the API.  

Checking other sources online has lead to solutions that didn’t actually work, or were related to AP bills. 

Any help would be appreciated! 

Best answer by KrunalDoshi

Hi ​@Mike0912,

Try making two separate API calls, where in the first you check the Apply Retainage and in the second call you add a Retainage Percentage. This might work. I assume you have added Retainage as a separate linked entity under parent Invoice entity as it is a separate tab in UI although both are in ARInvoice DAC.

2 replies

KrunalDoshi
Varsity I
Forum|alt.badge.img
  • Varsity I
  • Answer
  • March 20, 2026

Hi ​@Mike0912,

Try making two separate API calls, where in the first you check the Apply Retainage and in the second call you add a Retainage Percentage. This might work. I assume you have added Retainage as a separate linked entity under parent Invoice entity as it is a separate tab in UI although both are in ARInvoice DAC.


  • Author
  • Freshman I
  • March 22, 2026

Yes, this is the route we ended up going.  Wasn’t ideal, but it does work, thank you!