/
GET Remittance Line items
mO SharemO Share

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 Line items

Owned by Browntape KB Team (Unlicensed)
Sept 22, 2023

This API allows you to:

  1. Get all the remittance lines of a particular remittance id/reference using a combination of channel id and remittance reference. 

  2. Get all remittance lines an order using a combination of channel id & order reference as the parameter. 

Endpoint

API Method: GET

URL: https://app.browntape.com/0.11/remittances/getLines.json

Payload

{ “username”=”XXXXXXXXXX”, “auth_string”=”YYYYYYYYY”, “channel_id”=”27736”//optional, “remittance_ref”=”ABCD123”//optional, “order_references”=”ABCD123”//"optional, array", }

Response

{ "success": true, "result_count": 1, "results_per_page": 20, "page": "1", "data": [ { Remittance_line_items: []  }  ] }

Validations

  1. If the remittance module is not enabled for the client then we will get an error.

  2. Channel id is a mandatory parameter.

  3. Channel id must belong to an authenticated company.

  4. Order reference or remittance_reference is mandatory.

 

Related content