Documentación de Notes Ordinary Accounts

NAV Navigation

NotesOrdinaryAccountsApi v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Email: Iberinform Web: Iberinform

Authentication

  • API Key (ClientSecretHeader)

    • Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
  • API Key (APIKeyHeader)

    • Parameter Name: X-IBM-Client-Id, in: header.

Default

get__notesConsolidatedAccounts_{organisationID}

Code samples

URL obj = new URL("https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(

 new InputStreamReader(con.getInputStream()));

String inputLine;

StringBuffer response = new StringBuffer();

while ((inputLine = in.readLine()) != null) {

 response.append(inputLine);

}

in.close();

System.out.println(response.toString());




const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});


GET https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID} HTTP/1.1


Accept: application/json


 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY',

);


$client = new \GuzzleHttp\Client();


// Define array of request body.

$request_body = array();


try {

 $response = $client->request('GET','https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID}', array(

 'headers' => $headers,

 'json' => $request_body,

 )

 );

 print_r($response->getBody()->getContents());

 }

 catch (\GuzzleHttp\Exception\BadResponseException $e) {

 // handle exception or api errors.

 print_r($e->getMessage());

 }


 // ...


import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID}', headers = headers)


print(r.json())


require 'rest-client'

require 'json'


headers = {

 'Accept' => 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY'

}


result = RestClient.get 'https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)


# You can also use wget

curl -X GET https://$(catalog.host)/modules/notesConsolidatedAccounts/{organisationID} \

 -H 'Accept: application/json' \

 -H 'X-IBM-Client-Id: API_KEY' \

 -H 'X-IBM-Client-Secret: API_KEY'



GET /notesConsolidatedAccounts/{organisationID}

Parameters

Name In Type Required Description
organisationID path string true identificador de la firma
language query string false Idioma generación

Example responses

200 Response

"{"notAvailable":"string","wrapperYears":[{"audit":{"auditCost":"string","auditor":"string","notProvided":"string","reservations":"string"},"balanceInformation":{"balanceType":{"code":"string","value":"string"},"closeDate":"string","documentLink":"string","period":"string","startDate":"string","year":"string"},"customers":{"items":[{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"}],"unavailabilityReason":"string"},"investments":{"currentInvestments":{"date":"string","longTermInvestment":"string","shortTermInvestment":"string","totalInvestments":"string"},"previousInvestments":{"date":"string","longTermInvestment":"string","shortTermInvestment":"string","totalInvestments":"string"},"unavailabilityReason":"string"},"operations":{"operationCompanys":[{"businessInformation":{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"},"operations":{"purchases":"string","sales":"string"}}],"totalOperations":{"purchases":"string","sales":"string"},"unavailabilityReason":"string"},"suppliers":{"items":[{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"}],"unavailabilityReason":"string"},"transactionBalances":{"totalTransactionBalances":{"compensations":"string","interests":"string","providedGuarantees":"string","purchaseOfCurrentAssets":"string","purchaseOfNonCurrentAssets":"string","receivedGuarantees":"string","receivedServices":"string","renderedServices":"string","saleOfCurrentAssets":"string","saleOfNonCurrentAssets":"string"},"transactionCompanys":[{"businessInformation":{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"},"transactionAmounts":{"compensations":"string","interests":"string","providedGuarantees":"string","purchaseOfCurrentAssets":"string","purchaseOfNonCurrentAssets":"string","receivedGuarantees":"string","receivedServices":"string","renderedServices":"string","saleOfCurrentAssets":"string","saleOfNonCurrentAssets":"string"}}],"unavailabilityReason":"string"}}]}"


Responses

Status Meaning Description Schema
200 OK 200 OK NTAADetail
401 Unauthorized Unauthorized ErrorDetail
403 Forbidden Forbidden ErrorDetail
404 Not Found Recurso no encontrado ErrorDetail
500 Internal Server Error Internal error ErrorDetail

Schemas

ErrorDetail

"{"code":"string","message":"string","principal":"string","status":0}"



Properties

Name Type Required Restrictions Description
code string false none none
message string false none none
principal string false none none
status number false none none

NTAADetail

"{"notAvailable":"string","wrapperYears":[{"audit":{"auditCost":"string","auditor":"string","notProvided":"string","reservations":"string"},"balanceInformation":{"balanceType":{"code":"string","value":"string"},"closeDate":"string","documentLink":"string","period":"string","startDate":"string","year":"string"},"customers":{"items":[{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"}],"unavailabilityReason":"string"},"investments":{"currentInvestments":{"date":"string","longTermInvestment":"string","shortTermInvestment":"string","totalInvestments":"string"},"previousInvestments":{"date":"string","longTermInvestment":"string","shortTermInvestment":"string","totalInvestments":"string"},"unavailabilityReason":"string"},"operations":{"operationCompanys":[{"businessInformation":{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"},"operations":{"purchases":"string","sales":"string"}}],"totalOperations":{"purchases":"string","sales":"string"},"unavailabilityReason":"string"},"suppliers":{"items":[{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"}],"unavailabilityReason":"string"},"transactionBalances":{"totalTransactionBalances":{"compensations":"string","interests":"string","providedGuarantees":"string","purchaseOfCurrentAssets":"string","purchaseOfNonCurrentAssets":"string","receivedGuarantees":"string","receivedServices":"string","renderedServices":"string","saleOfCurrentAssets":"string","saleOfNonCurrentAssets":"string"},"transactionCompanys":[{"businessInformation":{"acronym":{"code":"string","value":"string"},"country":{"code":"string","value":"string"},"fullName":"string","taxId":"string"},"transactionAmounts":{"compensations":"string","interests":"string","providedGuarantees":"string","purchaseOfCurrentAssets":"string","purchaseOfNonCurrentAssets":"string","receivedGuarantees":"string","receivedServices":"string","renderedServices":"string","saleOfCurrentAssets":"string","saleOfNonCurrentAssets":"string"}}],"unavailabilityReason":"string"}}]}"



Properties

Name Type Required Restrictions Description
notAvailable string false none none
wrapperYears [object] false none none
  audit object false none none
   auditCost string false none none
   auditor string false none none
   notProvided string false none none
   reservations string false none none
  balanceInformation object false none none
   balanceType object false none none
    code string false none none
    value string false none none
   closeDate string false none none
   documentLink string false none none
   period string false none none
   startDate string false none none
   year string false none none
  customers object false none none
   items [object] false none none
    acronym object false none none
     code string false none none
     value string false none none
    country object false none none
     code string false none none
     value string false none none
    fullName string false none none
    taxId string false none none
   unavailabilityReason string false none none
  investments object false none none
   currentInvestments object false none none
    date string false none none
    longTermInvestment string false none none
    shortTermInvestment string false none none
    totalInvestments string false none none
   previousInvestments object false none none
    date string false none none
    longTermInvestment string false none none
    shortTermInvestment string false none none
    totalInvestments string false none none
   unavailabilityReason string false none none
  operations object false none none
   operationCompanys [object] false none none
    businessInformation object false none none
     acronym object false none none
      code string false none none
      value string false none none
     country object false none none
      code string false none none
      value string false none none
     fullName string false none none
     taxId string false none none
    operations object false none none
     purchases string false none none
     sales string false none none
   totalOperations object false none none
    purchases string false none none
    sales string false none none
   unavailabilityReason string false none none
  suppliers object false none none
   items [object] false none none
    acronym object false none none
     code string false none none
     value string false none none
    country object false none none
     code string false none none
     value string false none none
    fullName string false none none
    taxId string false none none
   unavailabilityReason string false none none
  transactionBalances object false none none
   totalTransactionBalances object false none none
    compensations string false none none
    interests string false none none
    providedGuarantees string false none none
    purchaseOfCurrentAssets string false none none
    purchaseOfNonCurrentAssets string false none none
    receivedGuarantees string false none none
    receivedServices string false none none
    renderedServices string false none none
    saleOfCurrentAssets string false none none
    saleOfNonCurrentAssets string false none none
   transactionCompanys [object] false none none
    businessInformation object false none none
     acronym object false none none
      code string false none none
      value string false none none
     country object false none none
      code string false none none
      value string false none none
     fullName string false none none
     taxId string false none none
    transactionAmounts object false none none
     compensations string false none none
     interests string false none none
     providedGuarantees string false none none
     purchaseOfCurrentAssets string false none none
     purchaseOfNonCurrentAssets string false none none
     receivedGuarantees string false none none
     receivedServices string false none none
     renderedServices string false none none
     saleOfCurrentAssets string false none none
     saleOfNonCurrentAssets string false none none
   unavailabilityReason string false none none

imagen de contacto

Solicita más información