Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Business connections

List all the business connections with your suppliers in your commercial network.

get

List all the business connections between your business and your suppliers in your commercial network.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Returns the list of business connections.

application/json
idstringRequired

id of this entity

Example: 123e4567-e89b-12d3-a456-426614174000
createdAtstringRequired

date that this connection was created

Example: 2021-01-01T00:00:00.000Z
updatedAtstringRequired

date that this connection was last updated

Example: 2021-01-01T00:00:00.000Z
customDataobjectRequired

metadata for this business connection. Only visible to the buyer who set this.

Example: {"foo":"bar"}
plotsCountnumberRequired

Total number of plots in this supplier's supply chain

Default: 0Example: 1
plotsCommoditiesstring[]Required

List of all commodities produced in this supplier's supply chain

Example: ["cattle","cocoa"]
riskScorenumber · max: 100Required

Risk score of this supplier's supply chain being 0 the lowest risk and 100 the highest risk.

Default: nullExample: 10
isRiskScorePartialboolean · nullableRequired

True when the risk score is based on partial data. Null when not entitled to the risk score.

plotRiskLevelsBreakdownobjectRequired

Breakdown of plots in this supplier's supply chain by deforestation risk level.

Example: {"none":2,"low":4,"medium":23,"high":8,"processing":{"OS":12,"PRECISION":1}}
get/business-connections/suppliers
GET /business-connections/suppliers HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sourceBusiness": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "suppliers": "[Circular Reference]",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  100.01,
                  0
                ],
                [
                  100.01,
                  0.01
                ],
                [
                  100,
                  0.01
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "riskAssessmentStatus": "NEW",
          "riskLevel": "none",
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewSurveyResponsesOfTier1Suppliers": false,
            "canDownloadSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false,
            "canManageCmsSupplierRiskAssessmentStatuses": false,
            "canViewCmsSurveys": false,
            "canViewSupplierRiskScore": false
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": "[Circular Reference]",
        "userInvitations": "[Circular Reference]",
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text",
      "tracesEnvironment": "ACCEPTANCE"
    },
    "targetBusiness": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "suppliers": "[Circular Reference]",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  100.01,
                  0
                ],
                [
                  100.01,
                  0.01
                ],
                [
                  100,
                  0.01
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "riskAssessmentStatus": "NEW",
          "riskLevel": "none",
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewSurveyResponsesOfTier1Suppliers": false,
            "canDownloadSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false,
            "canManageCmsSupplierRiskAssessmentStatuses": false,
            "canViewCmsSurveys": false,
            "canViewSupplierRiskScore": false
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": "[Circular Reference]",
        "userInvitations": "[Circular Reference]",
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text",
      "tracesEnvironment": "ACCEPTANCE"
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "customData": {
      "foo": "bar"
    },
    "plotsCount": 1,
    "plotsCommodities": [
      "cattle",
      "cocoa"
    ],
    "riskScore": 10,
    "isRiskScorePartial": true,
    "partialRiskScoreReasons": {
      "missingPlots": true,
      "missingSurveys": true
    },
    "plotRiskLevelsBreakdown": {
      "none": 2,
      "low": 4,
      "medium": 23,
      "high": 8,
      "processing": {
        "OS": 12,
        "PRECISION": 1
      }
    }
  }
]

List all the business connections with your buyers in your commercial network.

get

List all the business connections between your business and your buyers in your commercial network.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Returns the list of business connections.

application/json
idstringRequired

id of this entity

Example: 123e4567-e89b-12d3-a456-426614174000
createdAtstringRequired

date that this connection was created

Example: 2021-01-01T00:00:00.000Z
updatedAtstringRequired

date that this connection was last updated

Example: 2021-01-01T00:00:00.000Z
customDataobjectRequired

metadata for this business connection. Only visible to the buyer who set this.

Example: {"foo":"bar"}
plotsCountnumberRequired

Total number of plots in this supplier's supply chain

Default: 0Example: 1
plotsCommoditiesstring[]Required

List of all commodities produced in this supplier's supply chain

Example: ["cattle","cocoa"]
get/business-connections/buyers
GET /business-connections/buyers HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sourceBusiness": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "suppliers": "[Circular Reference]",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  100.01,
                  0
                ],
                [
                  100.01,
                  0.01
                ],
                [
                  100,
                  0.01
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "riskAssessmentStatus": "NEW",
          "riskLevel": "none",
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewSurveyResponsesOfTier1Suppliers": false,
            "canDownloadSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false,
            "canManageCmsSupplierRiskAssessmentStatuses": false,
            "canViewCmsSurveys": false,
            "canViewSupplierRiskScore": false
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": "[Circular Reference]",
        "userInvitations": "[Circular Reference]",
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text",
      "tracesEnvironment": "ACCEPTANCE"
    },
    "targetBusiness": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "suppliers": "[Circular Reference]",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  100.01,
                  0
                ],
                [
                  100.01,
                  0.01
                ],
                [
                  100,
                  0.01
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "riskAssessmentStatus": "NEW",
          "riskLevel": "none",
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewSurveyResponsesOfTier1Suppliers": false,
            "canDownloadSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false,
            "canManageCmsSupplierRiskAssessmentStatuses": false,
            "canViewCmsSurveys": false,
            "canViewSupplierRiskScore": false
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": "[Circular Reference]",
        "userInvitations": "[Circular Reference]",
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text",
      "tracesEnvironment": "ACCEPTANCE"
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "customData": {
      "foo": "bar"
    },
    "plotsCount": 1,
    "plotsCommodities": [
      "cattle",
      "cocoa"
    ]
  }
]

Update the custom data of a business connection

patch

Update the custom data of a business connection if you are the buyer (source business)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
customDataobjectRequired

A customizable metadata field for storing additional information related to a business invitation in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.

  The `customData` field is returned unchanged and is visible only to the owners of the business invitation.

  Constraints:
    - Up to 10 keys per object
    - Key length: Maximum 255 characters
    - String value length: Maximum 255 characters
    - Values must be of type: string, number, or boolean
    - Nested objects are not allowed
    - Keys cannot contain: '__proto__', 'constructor', or 'prototype'
Example: {"key1":"someValue","key2":true,"key3":1234}
Responses
200

Returns the updated business connection.

application/json
idstringRequired

id of this entity

Example: 123e4567-e89b-12d3-a456-426614174000
createdAtstringRequired

date that this connection was created

Example: 2021-01-01T00:00:00.000Z
updatedAtstringRequired

date that this connection was last updated

Example: 2021-01-01T00:00:00.000Z
customDataobjectRequired

metadata for this business connection. Only visible to the buyer who set this.

Example: {"foo":"bar"}
plotsCountnumberRequired

Total number of plots in this supplier's supply chain

Default: 0Example: 1
plotsCommoditiesstring[]Required

List of all commodities produced in this supplier's supply chain

Example: ["cattle","cocoa"]
patch/business-connections/{id}
PATCH /business-connections/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sourceBusiness": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "email": "user@example.com",
    "name": "Example Inc.",
    "username": "John Doe",
    "addressStreet": "Salawati 143",
    "addressZip": "98451",
    "addressPostcode": "12345",
    "addressArea": "Brandenburg",
    "addressCity": "West Papua",
    "addressCountryCode": "ID",
    "addressCountry": "Indonesia",
    "addressLine1": "Salawati 123",
    "addressLine2": "3rd floor",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "initialLocale": "id-ID",
    "units": "metric",
    "plots": [
      {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "suppliers": [
          "[Circular Reference]"
        ],
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                100,
                0
              ],
              [
                100.01,
                0
              ],
              [
                100.01,
                0.01
              ],
              [
                100,
                0.01
              ],
              [
                100,
                0
              ]
            ]
          ]
        },
        "commodities": [
          "oil palm",
          "rubber"
        ],
        "name": "text",
        "surfaceArea": 1,
        "countryCode": "text",
        "mostRecentAnalysis": {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "status": "PENDING",
          "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "analysedAt": "2023-07-28T09:13:37Z",
          "version": "open-source-1.0.0",
          "deforestedArea": 123.45,
          "deforestedGeometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  13,
                  52.5
                ],
                [
                  13.5,
                  52.5
                ],
                [
                  13.5,
                  52
                ],
                [
                  13,
                  52
                ],
                [
                  13,
                  52.5
                ]
              ]
            ]
          },
          "riskOfDeforestation": 0.3,
          "type": "OS",
          "customData": {
            "some": "metadata"
          },
          "name": "text"
        },
        "mostRecentAnalysesByType": {
          "EUFOROBS": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "PRECISION": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          }
        },
        "riskAssessmentStatus": "NEW",
        "riskLevel": "none",
        "filename": {},
        "description": "text",
        "ownerId": "text",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "newlyCreated": "true",
    "members": [
      {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      }
    ],
    "connectionsAsSource": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "connectionsAsTarget": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "businessInvitations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sentByUser": "[Circular Reference]",
        "business": "[Circular Reference]",
        "email": "user@example.com",
        "status": "PENDING",
        "createdAt": "2020-01-01T00:00:00.000Z",
        "updatedAt": "2020-01-01T00:00:00.000Z",
        "sourceIsInvitee": "true",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "contactPerson": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": "[Circular Reference]",
      "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "firstName": "Paul",
      "lastName": "Smith",
      "locale": "id-ID",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "completed": "false",
      "businessInvitations": [
        "[Circular Reference]"
      ],
      "userInvitations": [
        "[Circular Reference]"
      ],
      "email": "user@example.com",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false,
        "canManageTransactions": false,
        "canViewSurveyResponsesOfTier1Suppliers": false,
        "canDownloadSurveyResponses": false,
        "canManageWebhooks": false,
        "canAccessApi": false,
        "canManageCmsSupplierRiskAssessmentStatuses": false,
        "canViewCmsSurveys": false,
        "canViewSupplierRiskScore": false
      }
    },
    "machineToMachineClientId": "1234567890asdfghjk",
    "eori": "text",
    "vat": "text",
    "tracesEnvironment": "ACCEPTANCE"
  },
  "targetBusiness": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "email": "user@example.com",
    "name": "Example Inc.",
    "username": "John Doe",
    "addressStreet": "Salawati 143",
    "addressZip": "98451",
    "addressPostcode": "12345",
    "addressArea": "Brandenburg",
    "addressCity": "West Papua",
    "addressCountryCode": "ID",
    "addressCountry": "Indonesia",
    "addressLine1": "Salawati 123",
    "addressLine2": "3rd floor",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "initialLocale": "id-ID",
    "units": "metric",
    "plots": [
      {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "suppliers": [
          "[Circular Reference]"
        ],
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                100,
                0
              ],
              [
                100.01,
                0
              ],
              [
                100.01,
                0.01
              ],
              [
                100,
                0.01
              ],
              [
                100,
                0
              ]
            ]
          ]
        },
        "commodities": [
          "oil palm",
          "rubber"
        ],
        "name": "text",
        "surfaceArea": 1,
        "countryCode": "text",
        "mostRecentAnalysis": {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "status": "PENDING",
          "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "analysedAt": "2023-07-28T09:13:37Z",
          "version": "open-source-1.0.0",
          "deforestedArea": 123.45,
          "deforestedGeometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  13,
                  52.5
                ],
                [
                  13.5,
                  52.5
                ],
                [
                  13.5,
                  52
                ],
                [
                  13,
                  52
                ],
                [
                  13,
                  52.5
                ]
              ]
            ]
          },
          "riskOfDeforestation": 0.3,
          "type": "OS",
          "customData": {
            "some": "metadata"
          },
          "name": "text"
        },
        "mostRecentAnalysesByType": {
          "EUFOROBS": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "PRECISION": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          }
        },
        "riskAssessmentStatus": "NEW",
        "riskLevel": "none",
        "filename": {},
        "description": "text",
        "ownerId": "text",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "newlyCreated": "true",
    "members": [
      {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      }
    ],
    "connectionsAsSource": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "connectionsAsTarget": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "businessInvitations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sentByUser": "[Circular Reference]",
        "business": "[Circular Reference]",
        "email": "user@example.com",
        "status": "PENDING",
        "createdAt": "2020-01-01T00:00:00.000Z",
        "updatedAt": "2020-01-01T00:00:00.000Z",
        "sourceIsInvitee": "true",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "contactPerson": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": "[Circular Reference]",
      "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "firstName": "Paul",
      "lastName": "Smith",
      "locale": "id-ID",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "completed": "false",
      "businessInvitations": [
        "[Circular Reference]"
      ],
      "userInvitations": [
        "[Circular Reference]"
      ],
      "email": "user@example.com",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false,
        "canManageTransactions": false,
        "canViewSurveyResponsesOfTier1Suppliers": false,
        "canDownloadSurveyResponses": false,
        "canManageWebhooks": false,
        "canAccessApi": false,
        "canManageCmsSupplierRiskAssessmentStatuses": false,
        "canViewCmsSurveys": false,
        "canViewSupplierRiskScore": false
      }
    },
    "machineToMachineClientId": "1234567890asdfghjk",
    "eori": "text",
    "vat": "text",
    "tracesEnvironment": "ACCEPTANCE"
  },
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "customData": {
    "foo": "bar"
  },
  "plotsCount": 1,
  "plotsCommodities": [
    "cattle",
    "cocoa"
  ]
}
PreviousList all sent invitationsNextTransactions

Last updated