StatusSupportCommunity

Properties

OpenAPI V2

Retrieve file property.

get

Retrieve one of the properties of an file (for example for number of facts from a XBRL report).

Authorizations
Query parameters
typestringOptional

Filters to be applied.

Example: 372609e8-af2f-43ac-9
keystringOptional

Filters to be applied.

Example: share
Header parameters
x-api-versionstringRequired
ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Responses
application/json
object[]Optional
get
GET /customer-corner/instance/properties HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*

[
  {
    "id": "063be713...",
    "type": "91063921-5...",
    "key": "NumberOfFacts",
    "value": "2"
  }
]

Save file summary.

post

Save the properties of an file (for example for number of facts from a XBRL report).

Authorizations
Header parameters
x-api-versionstringRequired
ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Body
idstring · uuidOptional

File size.

Example: 063be713...
typestring | nullableOptional

ID of the action.

Example: 91063921-5...
keystring | nullableOptional

Name of action.

Example: NumberOfFacts
valuestring | nullableOptional

Actual value.

Example: 2
Responses
application/json
booleanOptional
post
POST /customer-corner/instance/properties HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 79

[
  {
    "id": "063be713...",
    "type": "91063921-5...",
    "key": "NumberOfFacts",
    "value": "2"
  }
]
true

Remove file summary.

delete

Remove the properties of an file (for example for number of facts from a XBRL report).

Authorizations
Query parameters
typestringOptional

Property to be deleted.

Example: 372609e8-af2f-43ac-9
keystringOptional

Property to be deleted.

Example: share
Header parameters
x-api-versionstringRequired
ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Responses
application/json
booleanOptional
delete
DELETE /customer-corner/instance/properties HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*

true
PreviousInstanceNextPDF

Was this helpful?