We’re excited to announce that the latest information is now available on our new site, the Ginesys One Wiki!. Visit the site for up-to-date resources and insights. We look forward to continuing to support you there!
We’re excited to announce that the latest information is now available on our new site, the Ginesys One Wiki!. Visit the site for up-to-date resources and insights. We look forward to continuing to support you there!
GET Remittance
- Browntape KB Team (Unlicensed)
This API enables you to:
Get the latest date bound remittances of a company using remittance_date_to/from as a parameter.
Get the latest date bound remittances of a channel using the channel id & remittance_date_to/from as a parameter.
Get a particular remittance (by ref) for a channel using the parameters - channel id & remittance_references.
include_remittance_line_items flag is assumed true if not passed.This means that even if the parameter include_remittance_line_items is not passed, this parameter will be considered TRUE by default although not visible in the parameters passed. This will be useful for companies with many orders per remittance.
Restricting the remittances upto 10 remittances per page since the remittance lines are also getting loaded and the query can get really heavy.
Endpoint
API Method: GET
URL: https://app.browntape.com/0.11/remittances/get.json
Note: This is a version 0.11 endpoint
Payload
{
“username”=”XXXXXXXXXX”,
“auth_string”=”YYYYYYYYY”,
“remittance_date_from”=”2022-01-0100: 00: 00”//optional,
“remittance_date_to”=”2022-04-0100: 00: 00”//optional,
“channel_id”=”27736”//conditional,
“remittance_references”="ABCD123"//optional, can take more than 1,
“include_remittance_line_items”=”true”,
“page_no”=”1”//"optional, needed for >1 page. Page size 10",
}Response
{
"success": true,
"result_count": 1,
"results_per_page": 10,
"page": 1,
"data": [
{
Remittance: {
…
},
Remittance_line_items: [
]
}
]
}Validations
If the remittance module is not enabled for the client then we will get an error.
If remittance_references parameter is passed, then channel id parameter is a must.
remittance_date_from must be less than remittance_date_to