Manuais
PHC GO Get Client Portal Document URL
 

Method


The method to be called is:




Get the Portal GO URL for one customer

Abrir/Fechar

 

JSON body


In the body of the POST a JSON structure like this one has to be passed:

1

2

3

4

5
{


"customer": {


"stamp": "81c-4fa9-bf9b-d1346eb11eb"


}

}

Return Information


Any call made to this method will return a JSON information with this structure:

  1. In case of success:


    1
    
2
    
3
    
4
    
5
    
6
    {
    

    "code": 1,
    

    "message": "Link obtained successfully.",
    

    "Customer no": "16",
    

    "Link to GO Portal": "http://phc202107013/phcgo/portal/customer/61NQfHsYx32QZnlg--wSsZOE8Gn1yri_bj4rUB49-RAQT0orotbwIhl6o8o3Xh3SrXQjef0IL9swYKgy5ZiY66NY_gCRJ7CtZs6aCwK6BV18YfJzUn7zR6iu2azrfQsW/accountsreceivable/"
    
}


  2. In case of error:


    1
    
2
    
3
    
4
    {
    

    "code": 100,
    

    "message": "Invalid stamp. Please, check your request."
    
}



JSON Specification for Create Customers



Customer


 
NameTypePHC GO EntityPHC GO FieldObservations
stampString--Using this parameter, the others (fromNumber, toNumber) will automatically be ignored, respectively, priority will be given to the method of obtaining the Portal Go Link for a single client.
fromNumberInteger--
toNumberInteger--

 

Get the Portal GO URL for multiple customers

Abrir/Fechar

 

JSON body


In the body of the POST a JSON structure like this one has to be passed:

1

2

3

4

5

6
{


"customer": {


"fromNumber": 1,


"toNumber": 2


}

}

Return Information


Any call made to this method will return a JSON information with this structure:

  1. In case of success:


     1
    
 2
    
 3
    
 4
    
 5
    
 6
    
 7
    
 8
    
 9
    
10
    [
    

    {
    

    "customerNumber": 2,
    

    "linkToGoPortal": "http://phc202107013/phcgo/portal/customer/iwpe1Dn5wUWhDr-eEce2P7VDvOES9bLlJqqCqiGqHUG05G0VTQIqhpFbAhW8YpxGMJi0eKguhNjJ1yp8r6A_H_pfdpgYD99q3Eqz_7INsHZiQ7d-DCOWEWTNUP-QyfH2/accountsreceivable/"
    

    },
    

    {
    

    "customerNumber": 1,
    

    "linkToGoPortal": "http://phc202107013/phcgo/portal/customer/N_xt8Jp3jwibaNHAXG_ibJBQd7NtBg9PrqYxWBgvwebR9-cRy66OwRijuAkGC2mtaOJ7XRcpNkqy8e8jtTC_ldBTuo6Sfkd5WCUpthFFF-A0il-jOJIzaiGVmc-J5PFV/accountsreceivable/"
    

    }
    
]


  2. In case of error:


    1
    
2
    
3
    
4
    
5
    
6
    
7
    
8
    {
    

    "code": 100,
    

    "message": "Invalid stamp. Please, check your request."
    
}
    
{
    

    "code": 100,
    

    "message": "No customer has been identified."
    
}



JSON Specification for Create Customers



Customer


 
NameTypePHC GO EntityPHC GO FieldObservations
stampString--Using this parameter, the others (fromNumber, toNumber) will automatically be ignored, respectively, priority will be given to the method of obtaining the Portal Go Link for a single client.
fromNumberInteger--
toNumberInteger--

 

 

PHC GO