generate_financial_report


POST  -- Generates a beneficiary's financial report for a given month

Argument Description Type - Length Example Mandatory
beneficiary_reference Beneficiary reference String - 64 YES
file_type File type String YES
year The year of the financial report String - 4 YES
month The month of the financial report String - 2 YES
Request

POST /xxxx/generate_financial_report HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json 

                                                
                                                    {
"beneficiary_reference": "xxxxxxxx",
"file_type": "pdf",
"year": "2023",
"month": "07"}
If the parameters sent are valid

Response

HTTP/1.1 200 OK
Content-Type: application/json 


                                                {
                                                    "result": true,
                                                    "file_encoded": "xxxxxxxxxxxxxxxxx"
                                                }
If the parameters sent are incorrect

Response

HTTP/1.1 200 OK
Content-Type: application/json 

                                                
                                                    {
                                                        "result": false,
                                                        "code": "EXIST_004",
                                                        "message": "beneficiary not exists"
                                                    }
                                                
                                            
                                                
                                                {
                                                    "result": false,
                                                    "error": "xxxxxxxxxxxxxxxxx"
                                                }