Skip to main content
GET
/
v1
/
companies
/
{company_id}
/
reports
/
{report_id}
Get General Report
curl --request GET \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id} \
  --header 'Authorization: <api-key>'
{
  "additional_information": "Goods' additional information",
  "companyID": 123,
  "createdAt": "<string>",
  "declarant_actor_address_city": "Declarant city",
  "declarant_actor_address_country": "BE",
  "declarant_identification_number": "BE1457893",
  "declarant_name": "Declarant CBAM",
  "importer_address_city": "Declarant city",
  "importer_address_country": "BE",
  "importer_identification_number": "GR293847584930295",
  "importer_name": "Declarant CBAM",
  "internalReportID": 123,
  "organizationID": 123,
  "reporting_period": "Q3",
  "representative_address_city": "Declarant city",
  "representative_address_country": "BE",
  "representative_identification_number": "IT293847584930295",
  "representative_name": "Representative CBAM",
  "role": "01",
  "signatures": {
    "global_data_confirmation": true,
    "other_applicable_reporting_methodology": true,
    "position_of_person_sending": "Position of person signing",
    "signature": "Signature (Full Name)",
    "signature_place": "Place of signature",
    "use_of_data_confirmation": true
  },
  "submission_date": "2023-08-08T08:21:14Z",
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "version": "<string>",
  "year": 2024
}

Authorizations

​
Authorization
string
header
required

Provide your Bearer token in the format: Bearer <your_api_key>

Path Parameters

​
company_id
string
required

Company ID associated with the general report

​
report_id
string
required

Report ID associated with the general report

Response

Successfully retrieved general report information" example({"status": "success", "data": {...}})

Summary of Struct

​
additional_information
string
required

Additional Information Additional Information (Min Length: 1, Max Length: 512)

Example:

"Goods' additional information"

​
declarant_actor_address_city
string
required

The city where the Declarant is located. The city where the Declarant is located. The city where the importer is located. The city where the Declarant is located. The city where the importer is located. The city where the operator is located. (Min Length: 1, Max Length: 35)

Example:

"Declarant city"

​
declarant_actor_address_country
string
required

The country where the Declarant is established The country where the Indirect customs representative is established The country where the Importer is established The country where the Indirect customs representative is established The country where the Importer is established . (Min Length: 2, Max Length: 2)

Example:

"BE"

​
declarant_identification_number
string
required

The Declarant's Economic Operators Registration and Identification (EORI) Number (Min Length: 1, Max Length: 17)

Example:

"BE1457893"

​
declarant_name
string
required

The full name (person or company) of the Declarant. (Min Length: 1, Max Length: 70)

Example:

"Declarant CBAM"

​
importer_address_city
string
required

The city where the Declarant is located. The city where the Declarant is located. The city where the importer is located. The city where the Declarant is located. The city where the importer is located. The city where the operator is located. (Min Length: 1, Max Length: 35)

Example:

"Declarant city"

​
importer_address_country
string
required

The country where the Declarant is established The country where the Indirect customs representative is established The country where the Importer is established The country where the Indirect customs representative is established The country where the Importer is established . (Min Length: 2, Max Length: 2)

Example:

"BE"

​
importer_identification_number
string
required

The Importer's Economic Operators Registration and Identification The Importer's Economic Operators Registration and Identification (EORI) Number (EORI) Number (Min Length: 1, Max Length: 17)

Example:

"GR293847584930295"

​
importer_name
string
required

The full name The full name (person or company) of the importer. (person or company) of the importer. (Min Length: 1, Max Length: 70)

Example:

"Declarant CBAM"

​
reporting_period
string
required

The Quarter of the year. (Q1,Q2,Q3,Q4) (Min Length: 2, Max Length: 2)

Example:

"Q3"

​
representative_address_city
string
required

The city where the Declarant is located. The city where the Declarant is located. The city where the importer is located. The city where the Declarant is located. The city where the importer is located. The city where the operator is located. (Min Length: 1, Max Length: 35)

Example:

"Declarant city"

​
representative_address_country
string
required

The country where the Declarant is established The country where the Indirect customs representative is established The country where the Importer is established The country where the Indirect customs representative is established The country where the Importer is established . (Min Length: 2, Max Length: 2)

Example:

"BE"

​
representative_identification_number
string
required

The Representative's Economic Operators Registration and Identification The Representative's Economic Operators Registration and Identification (EORI) Number (EORI) Number (Min Length: 1, Max Length: 17)

Example:

"IT293847584930295"

​
representative_name
string
required

The full name The full name (person or company) of the Indirect customs representative. (person or company) of the Indirect customs representative. (Min Length: 1, Max Length: 70)

Example:

"Representative CBAM"

​
role
string
required

The role that the Declarant has. If they are the importer or a Indirect customs representative. (Min Length: 1, Max Length: 5)

Example:

"01"

​
signatures
object
required

Summary of Struct

​
year
integer
required

The year for which the report is submitted. (Total Digits: 4)

Example:

2024

​
companyID
integer

Company identifier

​
createdAt
string

Creation time

​
internalReportID
integer

Internal report ID

​
organizationID
integer

Organization identifier

​
submission_date
string

The submission date of the report. (Pattern: \d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ)

Example:

"2023-08-08T08:21:14Z"

​
updatedAt
string

Last update time

​
updatedBy
string

Updater identifier

​
version
string

Report Versions