API documentation
Method list
Test your request
Changelog


getInventoryPayers
The method allows you to retrieve a list of payers available in BaseLinker storage.


Input parameters
filter_idint(optional) Limiting results to a specific payer ID
filter_namevarchar(40)(optional) Filtering by payer name (full or partial match)



Output data
The method returns the data in JSON format.
statusvarchar(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
payersarrayList of payers. Each element contains fields listed below
| - payer_idintPayer identifier
| - namevarchar(40)Payer name
| - addressvarchar(200)(optional) Payer address
| - postcodevarchar(20)(optional) Payer postal code
| - cityvarchar(80)(optional) Payer city
| - tax_novarchar(40)(optional) Payer tax identification number



Sample
Input data:
Output data:
A sample request in PHP: