Search code examples
acumatica

How do I retrieve the details of the Checks & Payments screen using the REST API?


I'm trying to use Postman to retrieve the details of the Checks & Payments via the REST API. I'm using the 'Check' endpoint, which lists the 'Details', but they all have a warning icon on the detail fields:

enter image description here

If I try to retrieve using this:

...22.200.001/Check?$expand=Details

I get this error message mess:

enter image description here

I have no idea what any of that means. I've used $expand=Details on other endpoints and it works find. What's wrong here?

Thanks...


Solution

  • There is nothing wrong actually. That warning message means you can get the Details section only if you are accessing 1 record either by keys or by ID. The below request should work fine and return the Details section if there is anything

    curl --location --request GET 'https://ACUMATICA_URL/entity/Default/20.200.001/Check/Payment/CHECK_NUMBER?$expand=Details'
    

    but this request will fail as it tries to get a list of records (even with limit=1 it is still a list) and not a single specific check

    curl --location --request GET 'https://ACUMATICA_URL/entity/Default/20.200.001/Check/Payment/?$expand=Details&$limit=1'