-
Notifications
You must be signed in to change notification settings - Fork 0
GET Payments by Recipient
Ksenyia edited this page Feb 1, 2017
·
4 revisions
Getting list of the payments by recipient limited by 2 parameters "limit" and "skip". To get the whole list, please set limit=0 and skip=50000 (Resource URI: 'transfersGov/0/50000')
Resource URI
transfersGov/{limit}/{skip}?{filters}
Resource Properties
Parameter | Description |
---|---|
limit | It limit the search. Default is 500. Eg. transfersGov/500/0 |
skip | Offset of next page result. Default is 0. Eg. transfersGov/500/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_unit: String,
transfer_value: Integer,
transfer_year: Integer,
transfer_level: String,
transfer_gov_entity: String
}
]
}
HTTP GET
Default Request
curl -GET http://end-point-uri/transfersGov/500/0
Response
HTTP Status Code 200
{
count: 20,
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_unit: "USD",
transfer_value: 5964000,
transfer_year: 2015
transfer_level: "country",
transfer_gov_entity: "AFIP DIRECCIÓN GENERAL IMPOSITIVA"
},
...
]
}