Skip to main content
Solved

Vendor Rest API - Insert/Update Payment Instructions


Forum|alt.badge.img

Hi Everyone,

Can anyone help me provide the Json request to insert the Payment Instructions details in the Vendors → Default Payment Settings → Payment Instruction details?

 

 

Best answer by harutyungevorgyan

Hello ​@nsmith51 ,

Let’s break it down into three easy steps: First, log in. Next, find the exact ID values for the payment method you need. Finally, send an HTTP request to update the values.

Auth via REST API:

Method: 

POST


URL:

{{YourAcumaticaInstanceURL}}/entity/auth/login

Body:
 

{
    "name" : "{{Username}}",
    "password" : "{{Password}}",
    "tenant" : "{{Tenant}}"
}


You can find the IDs you need for your request in the details of your Payment Method:
 


Last step - sending request to update values

Method: 

PUT


URL:

{{YourAcumaticaInstanceURL}}/entity/{{YourEndpoint-Or"Default"}}/{{YourEndpointVersion-Or"23.200.001"}}/Vendor

Body:
 

{
    "VendorID": {
        "value": "YOURVENDORID"
    },
    "PaymentMethod": {
        "value": "YOURPaymentMethod" //For example ACHBA
    },
    "PaymentInstructions": [
        {
            "PaymentInstructionsID": {
                "value": "YOURID"
            },
            "Value": {
                "value": "YOURVALUE"
            }
        } /*,
        {
            //next Instruction and so on
        }....*/
    ]
}

Let me know if you have any questions.

View original
Did this topic help you find an answer to your question?

8 replies

harutyungevorgyan
Jr Varsity I
Forum|alt.badge.img+1

Hello ​@nsmith51 ,

Let’s break it down into three easy steps: First, log in. Next, find the exact ID values for the payment method you need. Finally, send an HTTP request to update the values.

Auth via REST API:

Method: 

POST


URL:

{{YourAcumaticaInstanceURL}}/entity/auth/login

Body:
 

{
    "name" : "{{Username}}",
    "password" : "{{Password}}",
    "tenant" : "{{Tenant}}"
}


You can find the IDs you need for your request in the details of your Payment Method:
 


Last step - sending request to update values

Method: 

PUT


URL:

{{YourAcumaticaInstanceURL}}/entity/{{YourEndpoint-Or"Default"}}/{{YourEndpointVersion-Or"23.200.001"}}/Vendor

Body:
 

{
    "VendorID": {
        "value": "YOURVENDORID"
    },
    "PaymentMethod": {
        "value": "YOURPaymentMethod" //For example ACHBA
    },
    "PaymentInstructions": [
        {
            "PaymentInstructionsID": {
                "value": "YOURID"
            },
            "Value": {
                "value": "YOURVALUE"
            }
        } /*,
        {
            //next Instruction and so on
        }....*/
    ]
}

Let me know if you have any questions.


Forum|alt.badge.img
  • Author
  • Jr Varsity III
  • 59 replies
  • April 14, 2025

@harutyungevorgyan  Thanks for the response.

I just checked it but it is not working, please find the screenshot for reference.

 

 


harutyungevorgyan
Jr Varsity I
Forum|alt.badge.img+1
nsmith51 wrote:

@harutyungevorgyan  Thanks for the response.

I just checked it but it is not working, please find the screenshot for reference.

 

 

It should work because I checked it. Something is wrong with the request. Could you please try to do the simple GET request without a body using the same URL, and please send the whole exception in text here so I can review it.


harutyungevorgyan
Jr Varsity I
Forum|alt.badge.img+1
nsmith51 wrote:

@harutyungevorgyan  Thanks for the response.

I just checked it but it is not working, please find the screenshot for reference.

 

 

Also, you can try to send all IDs at once because for the ACH Payment method, all those are required:

 

{
    "VendorID": {
        "value": "YOURVendorID"
    },
    "PaymentMethod": {
        "value": "ACH"
    },
    "PaymentInstructions": [
        {
            "PaymentInstructionsID": {
                "value": "1"
            },
            "Value": {
                "value": "1"
            }
        },
        {
            "PaymentInstructionsID": {
                "value": "2"
            },
            "Value": {
                "value": "Te22st"
            }
        },
        {
            "PaymentInstructionsID": {
                "value": "3"
            },
            "Value": {
                "value": "111111111"
            }
        },
        {
            "PaymentInstructionsID": {
                "value": "4"
            },
            "Value": {
                "value": "test"
            }
        }
    ]
}

 


Forum|alt.badge.img
  • Author
  • Jr Varsity III
  • 59 replies
  • April 15, 2025

@harutyungevorgyan I'm still receiving the same issue with all the Payment Instruction IDs I've tried. Have you been able to test this on your end, and did it work successfully for you?


harutyungevorgyan
Jr Varsity I
Forum|alt.badge.img+1
nsmith51 wrote:

@harutyungevorgyan I'm still receiving the same issue with all the Payment Instruction IDs I've tried. Have you been able to test this on your end, and did it work successfully for you?

I rarely suggest a solution without testing it. Could you please try the GET request I requested to do, and could you also send me a picture of all web service endpoints you have? 

Also the full text of the error message.


Forum|alt.badge.img
  • Author
  • Jr Varsity III
  • 59 replies
  • April 15, 2025

Here are the more details for your reference.

 

Request:

{
    "VendorID": {
        "value": "AAVENDOR"
    },
    "PaymentMethod": {
        "value": "ACH"
    },
    "PaymentInstructions": [
        { 
            "PaymentInstructions": [
                {
                    "PaymentInstructionsID": {
                        "value": 1
                    },
                    "Value": {
                        "value": "011115678"
                    }
                },
                {
                    "PaymentInstructionsID": {
                        "value": 2
                    },
                    "Value": {
                        "value": "AA Vendor"
                    }
                },
                {
                    "PaymentInstructionsID": {
                        "value": 3
                    },
                    "Value": {
                        "value": "111111111"
                    }
                },
                {
                    "PaymentInstructionsID": {
                        "value": 4
                    },
                    "Value": {
                        "value": "Wells Fargo Updated"
                    }
                }
            ]
        }
    ]
}

 

 

GET Call - Getting same error

 

 

 

 

 

 


Forum|alt.badge.img
  • Author
  • Jr Varsity III
  • 59 replies
  • April 15, 2025

@harutyungevorgyan  I figured it out myself this issue and resolved and now it is working as expected. 

Thanks for your help.

 

 


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings