Skip to content

GET Payments by Project

Ksenyia edited this page Feb 1, 2017 · 11 revisions

Getting list of the payments by project limited by 2 parameters "limit" and "skip". To get the whole list, please set limit=0 and skip=50000 (Resource URI: 'transfers/0/50000')

Resource URI

transfers/{limit}/{skip}?{filters}

Resource Properties

Parameter Description
limit It limit the search. Default is 500. Eg. transfers/500/0
skip Offset of next page result. Default is 0. Eg. transfers/50/0
filters Filter by company(_id), country(_id), transfer_type, transfer_unit, transfer_year. Eg. transfers/50/0?company=585bbabf8bb3aa000f21230b&country=5808851f5e0ba42fc79bd51b&transfer_type=Tax&transfer_unit=USD&transfer_year=2015

Response Attribute

{
   count: Integer,
   errorList: Array,
   transfers: [
      {
          _id: String,
          company: {
              _id: String,
              company_name: String
          },
          country: {
              iso2: String,
              name: String
          },
          project_site: {
              _id: String,
              name: String,
              type: String
          },
          transfer_type: String,
          transfer_label: String,
          transfer_unit: String,
          transfer_value: Integer,
          transfer_year: Integer,
          transfer_level: String
     }
   ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/transfers/500/0?transfer_unit=USD&transfer_year=2015

Response

HTTP Status Code 200

{
   count: 10,
   errorList: [],
   transfers: [
      {
          _id: "581c4b0acab60b000f20d1bc",
          company: {
              _id: "581c4b08cab60b000f20d104",
              company_name: "Total"
          },
          country: {
              iso2: "AR",
              name: "Argentina"
          },
          project_site: {
              _id: "ar-tier-w26tdv",
              name: "Tierra del Fuego",
              type: "project"
          },      
          transfer_type: "License fees, rental fees, entry fees, and other considerations for licenses and/or
                         concessions",
          
          transfer_label: null,
          transfer_unit: "USD",
          transfer_value: 5964000,
          transfer_year: 2015
          transfer_level: "project"
     }, 
     ...
   ]
}
Clone this wiki locally