getInventoryPayers
The method allows you to retrieve a list of payers available in BaseLinker storage.
Input parameters
Output data:
A sample request in PHP:
| filter_id | int | (optional) Limiting results to a specific payer ID |
| filter_name | varchar(40) | (optional) Filtering by payer name (full or partial match) |
Output data
The method returns the data in JSON format.
| status | varchar(30) | SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code |
| payers | array | List of payers. Each element contains fields listed below |
| | - payer_id | int | Payer identifier |
| | - name | varchar(40) | Payer name |
| | - address | varchar(200) | (optional) Payer address |
| | - postcode | varchar(20) | (optional) Payer postal code |
| | - city | varchar(80) | (optional) Payer city |
| | - tax_no | varchar(40) | (optional) Payer tax identification number |
Sample
Input data:Output data:
A sample request in PHP: