Update General Report

curl --request PUT \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "additional_information": "Goods' additional information",
  "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",
  "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
  },
  "year": 2024,
  "companyID": 123,
  "createdAt": "<string>",
  "internalReportID": 123,
  "organizationID": 123,
  "submission_date": "2023-08-08T08:21:14Z",
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "version": "<string>"
}
EOF

import requests

url = "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}"

payload = {
    "additional_information": "Goods' additional information",
    "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",
    "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
    },
    "year": 2024,
    "companyID": 123,
    "createdAt": "<string>",
    "internalReportID": 123,
    "organizationID": 123,
    "submission_date": "2023-08-08T08:21:14Z",
    "updatedAt": "<string>",
    "updatedBy": "<string>",
    "version": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    additional_information: 'Goods\' additional information',
    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',
    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
    },
    year: 2024,
    companyID: 123,
    createdAt: '<string>',
    internalReportID: 123,
    organizationID: 123,
    submission_date: '2023-08-08T08:21:14Z',
    updatedAt: '<string>',
    updatedBy: '<string>',
    version: '<string>'
  })
};

fetch('https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'additional_information' => 'Goods\' additional information',
    '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',
    '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
    ],
    'year' => 2024,
    'companyID' => 123,
    'createdAt' => '<string>',
    'internalReportID' => 123,
    'organizationID' => 123,
    'submission_date' => '2023-08-08T08:21:14Z',
    'updatedAt' => '<string>',
    'updatedBy' => '<string>',
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}"

	payload := strings.NewReader("{\n  \"additional_information\": \"Goods' additional information\",\n  \"declarant_actor_address_city\": \"Declarant city\",\n  \"declarant_actor_address_country\": \"BE\",\n  \"declarant_identification_number\": \"BE1457893\",\n  \"declarant_name\": \"Declarant CBAM\",\n  \"importer_address_city\": \"Declarant city\",\n  \"importer_address_country\": \"BE\",\n  \"importer_identification_number\": \"GR293847584930295\",\n  \"importer_name\": \"Declarant CBAM\",\n  \"reporting_period\": \"Q3\",\n  \"representative_address_city\": \"Declarant city\",\n  \"representative_address_country\": \"BE\",\n  \"representative_identification_number\": \"IT293847584930295\",\n  \"representative_name\": \"Representative CBAM\",\n  \"role\": \"01\",\n  \"signatures\": {\n    \"global_data_confirmation\": true,\n    \"other_applicable_reporting_methodology\": true,\n    \"position_of_person_sending\": \"Position of person signing\",\n    \"signature\": \"Signature (Full Name)\",\n    \"signature_place\": \"Place of signature\",\n    \"use_of_data_confirmation\": true\n  },\n  \"year\": 2024,\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"submission_date\": \"2023-08-08T08:21:14Z\",\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additional_information\": \"Goods' additional information\",\n  \"declarant_actor_address_city\": \"Declarant city\",\n  \"declarant_actor_address_country\": \"BE\",\n  \"declarant_identification_number\": \"BE1457893\",\n  \"declarant_name\": \"Declarant CBAM\",\n  \"importer_address_city\": \"Declarant city\",\n  \"importer_address_country\": \"BE\",\n  \"importer_identification_number\": \"GR293847584930295\",\n  \"importer_name\": \"Declarant CBAM\",\n  \"reporting_period\": \"Q3\",\n  \"representative_address_city\": \"Declarant city\",\n  \"representative_address_country\": \"BE\",\n  \"representative_identification_number\": \"IT293847584930295\",\n  \"representative_name\": \"Representative CBAM\",\n  \"role\": \"01\",\n  \"signatures\": {\n    \"global_data_confirmation\": true,\n    \"other_applicable_reporting_methodology\": true,\n    \"position_of_person_sending\": \"Position of person signing\",\n    \"signature\": \"Signature (Full Name)\",\n    \"signature_place\": \"Place of signature\",\n    \"use_of_data_confirmation\": true\n  },\n  \"year\": 2024,\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"submission_date\": \"2023-08-08T08:21:14Z\",\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additional_information\": \"Goods' additional information\",\n  \"declarant_actor_address_city\": \"Declarant city\",\n  \"declarant_actor_address_country\": \"BE\",\n  \"declarant_identification_number\": \"BE1457893\",\n  \"declarant_name\": \"Declarant CBAM\",\n  \"importer_address_city\": \"Declarant city\",\n  \"importer_address_country\": \"BE\",\n  \"importer_identification_number\": \"GR293847584930295\",\n  \"importer_name\": \"Declarant CBAM\",\n  \"reporting_period\": \"Q3\",\n  \"representative_address_city\": \"Declarant city\",\n  \"representative_address_country\": \"BE\",\n  \"representative_identification_number\": \"IT293847584930295\",\n  \"representative_name\": \"Representative CBAM\",\n  \"role\": \"01\",\n  \"signatures\": {\n    \"global_data_confirmation\": true,\n    \"other_applicable_reporting_methodology\": true,\n    \"position_of_person_sending\": \"Position of person signing\",\n    \"signature\": \"Signature (Full Name)\",\n    \"signature_place\": \"Place of signature\",\n    \"use_of_data_confirmation\": true\n  },\n  \"year\": 2024,\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"submission_date\": \"2023-08-08T08:21:14Z\",\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Operation completed successfully",
  "status": 200
}

{
  "message": "The JSON payload is invalid",
  "status": 400
}

{
  "message": "Validation failed for the provided data",
  "status": 422,
  "validation_errors": [
    {
      "description": "A value is required",
      "field": "example_field",
      "invalid_value": "",
      "message": "The exampleField is required",
      "rule": "non-empty",
      "tag": "required"
    }
  ]
}

{
  "message": "An internal server error occurred",
  "status": 500
}

PUT

companies

{company_id}

reports

{report_id}

Update General Report

curl --request PUT \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "additional_information": "Goods' additional information",
  "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",
  "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
  },
  "year": 2024,
  "companyID": 123,
  "createdAt": "<string>",
  "internalReportID": 123,
  "organizationID": 123,
  "submission_date": "2023-08-08T08:21:14Z",
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "version": "<string>"
}
EOF

import requests

url = "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}"

payload = {
    "additional_information": "Goods' additional information",
    "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",
    "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
    },
    "year": 2024,
    "companyID": 123,
    "createdAt": "<string>",
    "internalReportID": 123,
    "organizationID": 123,
    "submission_date": "2023-08-08T08:21:14Z",
    "updatedAt": "<string>",
    "updatedBy": "<string>",
    "version": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    additional_information: 'Goods\' additional information',
    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',
    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
    },
    year: 2024,
    companyID: 123,
    createdAt: '<string>',
    internalReportID: 123,
    organizationID: 123,
    submission_date: '2023-08-08T08:21:14Z',
    updatedAt: '<string>',
    updatedBy: '<string>',
    version: '<string>'
  })
};

fetch('https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'additional_information' => 'Goods\' additional information',
    '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',
    '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
    ],
    'year' => 2024,
    'companyID' => 123,
    'createdAt' => '<string>',
    'internalReportID' => 123,
    'organizationID' => 123,
    'submission_date' => '2023-08-08T08:21:14Z',
    'updatedAt' => '<string>',
    'updatedBy' => '<string>',
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}"

	payload := strings.NewReader("{\n  \"additional_information\": \"Goods' additional information\",\n  \"declarant_actor_address_city\": \"Declarant city\",\n  \"declarant_actor_address_country\": \"BE\",\n  \"declarant_identification_number\": \"BE1457893\",\n  \"declarant_name\": \"Declarant CBAM\",\n  \"importer_address_city\": \"Declarant city\",\n  \"importer_address_country\": \"BE\",\n  \"importer_identification_number\": \"GR293847584930295\",\n  \"importer_name\": \"Declarant CBAM\",\n  \"reporting_period\": \"Q3\",\n  \"representative_address_city\": \"Declarant city\",\n  \"representative_address_country\": \"BE\",\n  \"representative_identification_number\": \"IT293847584930295\",\n  \"representative_name\": \"Representative CBAM\",\n  \"role\": \"01\",\n  \"signatures\": {\n    \"global_data_confirmation\": true,\n    \"other_applicable_reporting_methodology\": true,\n    \"position_of_person_sending\": \"Position of person signing\",\n    \"signature\": \"Signature (Full Name)\",\n    \"signature_place\": \"Place of signature\",\n    \"use_of_data_confirmation\": true\n  },\n  \"year\": 2024,\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"submission_date\": \"2023-08-08T08:21:14Z\",\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additional_information\": \"Goods' additional information\",\n  \"declarant_actor_address_city\": \"Declarant city\",\n  \"declarant_actor_address_country\": \"BE\",\n  \"declarant_identification_number\": \"BE1457893\",\n  \"declarant_name\": \"Declarant CBAM\",\n  \"importer_address_city\": \"Declarant city\",\n  \"importer_address_country\": \"BE\",\n  \"importer_identification_number\": \"GR293847584930295\",\n  \"importer_name\": \"Declarant CBAM\",\n  \"reporting_period\": \"Q3\",\n  \"representative_address_city\": \"Declarant city\",\n  \"representative_address_country\": \"BE\",\n  \"representative_identification_number\": \"IT293847584930295\",\n  \"representative_name\": \"Representative CBAM\",\n  \"role\": \"01\",\n  \"signatures\": {\n    \"global_data_confirmation\": true,\n    \"other_applicable_reporting_methodology\": true,\n    \"position_of_person_sending\": \"Position of person signing\",\n    \"signature\": \"Signature (Full Name)\",\n    \"signature_place\": \"Place of signature\",\n    \"use_of_data_confirmation\": true\n  },\n  \"year\": 2024,\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"submission_date\": \"2023-08-08T08:21:14Z\",\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additional_information\": \"Goods' additional information\",\n  \"declarant_actor_address_city\": \"Declarant city\",\n  \"declarant_actor_address_country\": \"BE\",\n  \"declarant_identification_number\": \"BE1457893\",\n  \"declarant_name\": \"Declarant CBAM\",\n  \"importer_address_city\": \"Declarant city\",\n  \"importer_address_country\": \"BE\",\n  \"importer_identification_number\": \"GR293847584930295\",\n  \"importer_name\": \"Declarant CBAM\",\n  \"reporting_period\": \"Q3\",\n  \"representative_address_city\": \"Declarant city\",\n  \"representative_address_country\": \"BE\",\n  \"representative_identification_number\": \"IT293847584930295\",\n  \"representative_name\": \"Representative CBAM\",\n  \"role\": \"01\",\n  \"signatures\": {\n    \"global_data_confirmation\": true,\n    \"other_applicable_reporting_methodology\": true,\n    \"position_of_person_sending\": \"Position of person signing\",\n    \"signature\": \"Signature (Full Name)\",\n    \"signature_place\": \"Place of signature\",\n    \"use_of_data_confirmation\": true\n  },\n  \"year\": 2024,\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"submission_date\": \"2023-08-08T08:21:14Z\",\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Operation completed successfully",
  "status": 200
}

{
  "message": "The JSON payload is invalid",
  "status": 400
}

{
  "message": "Validation failed for the provided data",
  "status": 422,
  "validation_errors": [
    {
      "description": "A value is required",
      "field": "example_field",
      "invalid_value": "",
      "message": "The exampleField is required",
      "rule": "non-empty",
      "tag": "required"
    }
  ]
}

{
  "message": "An internal server error occurred",
  "status": 500
}

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

Body

application/json

General report information payload

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

Example:

"Declarant city"

importer_address_country

string

required

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

Example:

"Declarant city"

representative_address_country

string

required

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

Show child attributes

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

Response

General report information successfully updated" example({"status": "success", "message": "Updated successfully", "data": {...}})

A standard successful API response.

message

string

A detailed success message.

Example:

"Operation completed successfully"

status

integer

HTTP status code.

Example:

200

API Documentation

EU CBAM

Update General Report

Authorizations

Path Parameters

Body

Response