Skip to main content
PUT
/
v1
/
companies
/
{company_id}
/
reports
/
{report_id}
/
items
/
{item_id}
/
documents
Update Document
curl --request PUT \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/items/{item_id}/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "binary": [
    123
  ],
  "companyID": 123,
  "country": "CA",
  "createdAt": "<string>",
  "description": "Description",
  "document_type": "GENERAL",
  "filename": "Supporting_document_01.docx",
  "internalReportID": 123,
  "issuing_auth_name": "Issuing authority name",
  "item_number": "1",
  "line_item_number": 88888,
  "mime": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "organizationID": 123,
  "reference_number": "01 Reference number",
  "sequence_number": 1,
  "type": "01",
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "uri": "<string>",
  "validity_end_date": "1/1/24",
  "validity_start_date": "1/1/24",
  "version": "<string>"
}'
{
  "message": "Operation completed successfully",
  "status": 200
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
company_id
string
required

Unique identifier for the company associated with the imported good documents

​
report_id
string
required

Unique identifier for the report associated with the imported good documents

​
item_id
string
required

Unique identifier for the item associated with the imported good documents

Body

application/json

Payload for supporting documents

Summary of Struct

​
binary
integer[]
required

The actual binary object. The actual binary object.

​
document_type
enum<string>
required

Document type

Available options:
GENERAL,
EMISSIONS
​
filename
string
required

The file name of the attachment. The file name of the attachment. (Min Length: 1, Max Length: 256)

Example:

"Supporting_document_01.docx"

​
item_number
string
required

Import Good Item Number, sequencial This element specifies the item number of every CBAM Good imported of the CBAM Report. It is a sequential number starting at 1. (1,2..)

Example:

"1"

​
mime
string
required

The MIME of the attachment. The MIME of the attachment. (Min Length: 1, Max Length: 71)

Example:

"application/vnd.openxmlformats-officedocument.wordprocessingml.document"

​
type
string
required

The type of supporting document This element is used to define the type of emissions document that is declared. It is in the Supporting Documents (for emissions definition). (it is in the Supporting Documents (for Goods)). (Min Length: 4, Max Length: 4)

Example:

"01"

​
companyID
integer

Company identifier

​
country
string

The country where the supporting document was issued. The country where the supporting document was issued. (Min Length: 2, Max Length: 2)

Example:

"CA"

​
createdAt
string

Creation time

​
description
string

A text element to describe the supporting document. A text element to describe the supporting document. (Min Length: 1, Max Length: 256)

Example:

"Description"

​
internalReportID
integer

Internal report ID

​
issuing_auth_name
string

The authority that issued the supporting document. The authority that issued the supporting document. (Min Length: 1, Max Length: 70)

Example:

"Issuing authority name"

​
line_item_number
integer

The document line item number is the number of the Goods imported entry in which the supporting documents corresponding to. The document line item number is the number of the Goods imported entry in which the supporting documents corresponding to. (Pattern: \d{1,5})

Example:

88888

​
organizationID
integer

Organization identifier

​
reference_number
string

The reference number of the supporting document. The reference number of the supporting document. (Min Length: 1, Max Length: 70)

Example:

"01 Reference number"

​
sequence_number
integer

Supporting document sequence number. (Pattern: \d{1,5})

Example:

1

​
updatedAt
string

Last update time

​
updatedBy
string

Updater identifier

​
uri
string

The URI link of an attachment. The URI link of an attachment. (Min Length: 1, Max Length: 2048)

​
validity_end_date
string

The end date of validity of the supporting document. The end date of validity of the supporting document. (Pattern: \d{4}-\d\d-\d\d)

Example:

"1/1/24"

​
validity_start_date
string

The start date of validity of the supporting document. The start date of validity of the supporting document. (Pattern: \d{4}-\d\d-\d\d)

Example:

"1/1/24"

​
version
string

Report Versions

Response

Successfully updated or inserted imported good documents

A standard successful API response.

​
message
string

A detailed success message.

Example:

"Operation completed successfully"

​
status
integer

HTTP status code.

Example:

200