Skip to content

Schemas

All data models used by the TRF Data API.

Overview


AuthApiResponse

Type: object

Field Type Required Description
result AuthResult No

Example:

{
  "result": {
    "name": "string",
    "token": "string"
  }
}

AuthRequest

Type: object

Field Type Required Description
clientId string (uuid) Yes
secretKey string Yes (nullable)

Example:

{
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "secretKey": "string"
}

AuthResult

Type: object

Field Type Required Description
name string No (nullable)
token string No (nullable)

Example:

{
  "name": "string",
  "token": "string"
}

CdfType

Type: enum (string)

Values:

  • Transforma
  • Receiver

ConamaColor

Type: enum (string)

Values:

  • Orange
  • Black
  • Blue
  • Red
  • Green
  • Yellow
  • Brown
  • Gray
  • Unavailable
  • White

CtfModel

Type: object

Field Type Required Description
id integer (int64) No
vendor VendorModel No
number string No (nullable)
issuedDate string (date-time) No (nullable)
expirationDate string (date-time) No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "vendor": {
    "id": "string",
    "name": "string",
    "cnpj": "string",
    "isTransporter": true,
    "isReceiver": true
  },
  "number": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "expirationDate": "2024-01-15T10:30:00Z",
  "documentUrl": "string"
}

CtfModelPagedApiResponse

Type: object

Field Type Required Description
total integer (int32) No (nullable)
page integer (int32) No (nullable)
size integer (int32) No (nullable)
data array\<CtfModel> No (nullable)

Example:

{
  "total": 0,
  "page": 0,
  "size": 0,
  "data": [
    {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "documentUrl": "string"
    }
  ]
}

EnvironmentalDocumentModel

Type: object

Field Type Required Description
id integer (int64) No
vendor VendorModel No
documentType EnvironmentalDocumentTypeModel No
number string No (nullable)
description string No (nullable)
issuedDate string (date-time) No (nullable)
expirationDate string (date-time) No (nullable)
enabled boolean No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "vendor": {
    "id": "string",
    "name": "string",
    "cnpj": "string",
    "isTransporter": true,
    "isReceiver": true
  },
  "documentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "enabled": true,
    "expirable": true,
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "mandatoryVendorTypes": [
      "OnlyReceiver"
    ]
  },
  "number": "string",
  "description": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "expirationDate": "2024-01-15T10:30:00Z",
  "enabled": true,
  "documentUrl": "string"
}

EnvironmentalDocumentModelPagedApiResponse

Type: object

Field Type Required Description
total integer (int32) No (nullable)
page integer (int32) No (nullable)
size integer (int32) No (nullable)
data array\<EnvironmentalDocumentModel> No (nullable)

Example:

{
  "total": 0,
  "page": 0,
  "size": 0,
  "data": [
    {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "documentType": {
        "id": 0,
        "name": "string",
        "description": "string",
        "enabled": true,
        "expirable": true,
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "mandatoryVendorTypes": [
          "..."
        ]
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "enabled": true,
      "documentUrl": "string"
    }
  ]
}

EnvironmentalDocumentTypeModel

Type: object

Field Type Required Description
id integer (int64) No
name string No (nullable)
description string No (nullable)
enabled boolean No
expirable boolean No
issuedDate string (date-time) No (nullable)
expirationDate string (date-time) No (nullable)
mandatoryVendorTypes array\<VendorType> No (nullable)

Example:

{
  "id": 0,
  "name": "string",
  "description": "string",
  "enabled": true,
  "expirable": true,
  "issuedDate": "2024-01-15T10:30:00Z",
  "expirationDate": "2024-01-15T10:30:00Z",
  "mandatoryVendorTypes": [
    "OnlyReceiver"
  ]
}

EnvironmentalLicenseModel

Type: object

Field Type Required Description
id integer (int64) No
vendor VendorModel No
number string No (nullable)
description string No (nullable)
issuedDate string (date-time) No (nullable)
expirationDate string (date-time) No (nullable)
licenseType LicenseType No
licenseActivity LicenseActivity No
renewalProtocols array\<LicenseRenewalProtocolModel> No (nullable)
annotations array\<LicenseAnnotationModel> No (nullable)
supplementaryDocuments array\<LicenseSupplementaryDocumentModel> No (nullable)
licensePortSigres array\<LicensePortSigreModel> No (nullable)
licensedActivitiesCode string No (nullable)
scope string No (nullable)
organ string No (nullable)
state string No (nullable)
observation string No (nullable)
enabled boolean No
defaultDisposingVendorSigre string No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "vendor": {
    "id": "string",
    "name": "string",
    "cnpj": "string",
    "isTransporter": true,
    "isReceiver": true
  },
  "number": "string",
  "description": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "expirationDate": "2024-01-15T10:30:00Z",
  "licenseType": "Operation",
  "licenseActivity": "Receiver",
  "renewalProtocols": [
    {
      "id": 0,
      "environmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "enabled": true,
      "documentUrl": "string"
    }
  ],
  "annotations": [
    {
      "id": 0,
      "environmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "enabled": true,
      "documentUrl": "string"
    }
  ],
  "supplementaryDocuments": [
    {
      "id": 0,
      "environmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "number": "string",
      "description": "string",
      "type": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "enabled": true,
      "documentUrl": "string"
    }
  ],
  "licensePortSigres": [
    {
      "id": 0,
      "environmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "port": {
        "id": 0,
        "name": "string",
        "distanceToUtrInKm": 0,
        "location": {
          "id": "...",
          "name": "...",
          "distanceUtr": "...",
          "enabled": "..."
        },
        "enabled": true,
        "address": "string",
        "regionNtIbamaIdxPetrobras": 0,
        "petrobrasName": "string"
      },
      "receiverSigreText": "string"
    }
  ],
  "licensedActivitiesCode": "string",
  "scope": "string",
  "organ": "string",
  "state": "string",
  "observation": "string",
  "enabled": true,
  "defaultDisposingVendorSigre": "string",
  "documentUrl": "string"
}

EnvironmentalLicenseModelPagedApiResponse

Type: object

Field Type Required Description
total integer (int32) No (nullable)
page integer (int32) No (nullable)
size integer (int32) No (nullable)
data array\<EnvironmentalLicenseModel> No (nullable)

Example:

{
  "total": 0,
  "page": 0,
  "size": 0,
  "data": [
    {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  ]
}

FcdrModel

Type: object

Field Type Required Description
id integer (int64) No
number string No (nullable)
date string (date-time) No (nullable)
estimatedWeight number (double) No (nullable)
itemNumber number (double) No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "number": "string",
  "date": "2024-01-15T10:30:00Z",
  "estimatedWeight": 0.0,
  "itemNumber": 0.0,
  "documentUrl": "string"
}

GeneratorModel

Type: object

Field Type Required Description
id string No (nullable)
name string No (nullable)
cnpj string No (nullable)

Example:

{
  "id": "string",
  "name": "string",
  "cnpj": "string"
}

InboundManifestModel

Type: object

Field Type Required Description
id integer (int64) No
number string No (nullable)
residue ResidueModel No
residueNameComplement string No (nullable)
issuedDate string (date-time) No
quantity number (double) No (nullable)
measuringUnit MeasuringUnit No
treatment TreatmentModel No
packaging PackagingModel No
packagingIdentification string No (nullable)
generatorLicense EnvironmentalLicenseModel No
transporterLicense EnvironmentalLicenseModel No
driverName string No (nullable)
vehiclePlate string No (nullable)
receiverLicense EnvironmentalLicenseModel No
observation string No (nullable)
receivingTimestamp string (date-time) No
conclusionTimestamp string (date-time) No
documentUrl string No (nullable, read-only)
documentUrlCarbonCopies string No (nullable, read-only)

Example:

{
  "id": 0,
  "number": "string",
  "residue": {
    "id": 0,
    "code": "string",
    "name": "string",
    "sigreRef": "string",
    "totalSaRef": "string",
    "isChemicalProduct": true,
    "conamaColor": "Orange",
    "classification": "ClassI",
    "phisicalState": "Solid",
    "nameCompositions": [
      {
        "id": 0,
        "name": "string",
        "code": "string",
        "resolution": "Nbr10004"
      }
    ],
    "observation": "string",
    "petrobrasPackagingPlace": "string",
    "petrobrasDefaultPackagingType": "string",
    "inboundEnvironmentalLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  },
  "residueNameComplement": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "quantity": 0.0,
  "measuringUnit": "Kg",
  "treatment": {
    "id": 0,
    "name": "string",
    "type": "Inbound",
    "sigreRef": "string"
  },
  "packaging": {
    "id": 0,
    "name": "string",
    "sigreRef": "string"
  },
  "packagingIdentification": "string",
  "generatorLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "transporterLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "driverName": "string",
  "vehiclePlate": "string",
  "receiverLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "observation": "string",
  "receivingTimestamp": "2024-01-15T10:30:00Z",
  "conclusionTimestamp": "2024-01-15T10:30:00Z",
  "documentUrl": "string",
  "documentUrlCarbonCopies": "string"
}

IneaCdfModel

Type: object

Field Type Required Description
id integer (int64) No
receiver VendorModel No
number string No (nullable)
issuedDate string (date-time) No
inclusionDate string (date-time) No
periodStart string (date-time) No
periodEnd string (date-time) No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "receiver": {
    "id": "string",
    "name": "string",
    "cnpj": "string",
    "isTransporter": true,
    "isReceiver": true
  },
  "number": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "inclusionDate": "2024-01-15T10:30:00Z",
  "periodStart": "2024-01-15T10:30:00Z",
  "periodEnd": "2024-01-15T10:30:00Z",
  "documentUrl": "string"
}

IneaReceptionReportModel

Type: object

Field Type Required Description
id integer (int64) No
conclusionTimestamp string (date-time) No
manifestNumber string No (nullable)
receivingResponsible string No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "conclusionTimestamp": "2024-01-15T10:30:00Z",
  "manifestNumber": "string",
  "receivingResponsible": "string",
  "documentUrl": "string"
}

LicenseActivity

Type: enum (string)

Values:

  • Receiver
  • Transporter
  • ReceiverAndTransporter

LicenseAnnotationModel

Type: object

Field Type Required Description
id integer (int64) No
environmentalLicense EnvironmentalLicenseModel No
number string No (nullable)
description string No (nullable)
issuedDate string (date-time) No (nullable)
enabled boolean No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "environmentalLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "number": "string",
  "description": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "enabled": true,
  "documentUrl": "string"
}

LicensePortSigreModel

Type: object

Field Type Required Description
id integer (int64) No
environmentalLicense EnvironmentalLicenseModel No
port PortModel No
receiverSigreText string No (nullable)

Example:

{
  "id": 0,
  "environmentalLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "port": {
    "id": 0,
    "name": "string",
    "distanceToUtrInKm": 0,
    "location": {
      "id": 0,
      "name": "string",
      "distanceUtr": 0,
      "enabled": true
    },
    "enabled": true,
    "address": "string",
    "regionNtIbamaIdxPetrobras": 0,
    "petrobrasName": "string"
  },
  "receiverSigreText": "string"
}

LicenseRenewalProtocolModel

Type: object

Field Type Required Description
id integer (int64) No
environmentalLicense EnvironmentalLicenseModel No
number string No (nullable)
description string No (nullable)
issuedDate string (date-time) No (nullable)
enabled boolean No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "environmentalLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "number": "string",
  "description": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "enabled": true,
  "documentUrl": "string"
}

LicenseSupplementaryDocumentModel

Type: object

Field Type Required Description
id integer (int64) No
environmentalLicense EnvironmentalLicenseModel No
number string No (nullable)
description string No (nullable)
type string No (nullable)
issuedDate string (date-time) No (nullable)
enabled boolean No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "environmentalLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "number": "string",
  "description": "string",
  "type": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "enabled": true,
  "documentUrl": "string"
}

LicenseType

Type: enum (string)

Values:

  • Operation
  • OperationSimplified
  • Installation
  • PriorInstallation
  • InstallationAndOperation

LocationModel

Type: object

Field Type Required Description
id integer (int64) No
name string No (nullable)
distanceUtr integer (int32) No (nullable)
enabled boolean No

Example:

{
  "id": 0,
  "name": "string",
  "distanceUtr": 0,
  "enabled": true
}

MeasuringUnit

Type: enum (string)

Values:

  • Kg
  • Un
  • M3
  • Lt

OperationalUnitModel

Type: object

Field Type Required Description
id integer (int64) No
type OperationalUnitType No
name string No (nullable)
acronym string No (nullable)
location LocationModel No
vesselType string No (nullable)
treatmentPreferences array\<OperationalUnitTreatmentPreferenceModel> No (nullable)
petrobrasName string No (nullable)
petrobrasManagement string No (nullable)
regionNtIbamaIdxPetrobras integer (int32) No (nullable)
petrobrasGenerationPlace string No (nullable)
petrobrasPackagingType string No (nullable)

Example:

{
  "id": 0,
  "type": "Base",
  "name": "string",
  "acronym": "string",
  "location": {
    "id": 0,
    "name": "string",
    "distanceUtr": 0,
    "enabled": true
  },
  "vesselType": "string",
  "treatmentPreferences": [
    {
      "id": 0,
      "residue": {
        "id": 0,
        "code": "string",
        "name": "string",
        "sigreRef": "string",
        "totalSaRef": "string",
        "isChemicalProduct": true,
        "conamaColor": "Orange",
        "classification": "ClassI",
        "phisicalState": "Solid",
        "nameCompositions": [
          "..."
        ],
        "observation": "string",
        "petrobrasPackagingPlace": "string",
        "petrobrasDefaultPackagingType": "string",
        "inboundEnvironmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        }
      },
      "measuringUnit": "Kg",
      "treatment": {
        "id": 0,
        "name": "string",
        "type": "Inbound",
        "sigreRef": "string"
      },
      "environmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      }
    }
  ],
  "petrobrasName": "string",
  "petrobrasManagement": "string",
  "regionNtIbamaIdxPetrobras": 0,
  "petrobrasGenerationPlace": "string",
  "petrobrasPackagingType": "string"
}

OperationalUnitTreatmentPreferenceModel

Type: object

Field Type Required Description
id integer (int64) No
residue ResidueModel No
measuringUnit MeasuringUnit No
treatment TreatmentModel No
environmentalLicense EnvironmentalLicenseModel No

Example:

{
  "id": 0,
  "residue": {
    "id": 0,
    "code": "string",
    "name": "string",
    "sigreRef": "string",
    "totalSaRef": "string",
    "isChemicalProduct": true,
    "conamaColor": "Orange",
    "classification": "ClassI",
    "phisicalState": "Solid",
    "nameCompositions": [
      {
        "id": 0,
        "name": "string",
        "code": "string",
        "resolution": "Nbr10004"
      }
    ],
    "observation": "string",
    "petrobrasPackagingPlace": "string",
    "petrobrasDefaultPackagingType": "string",
    "inboundEnvironmentalLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  },
  "measuringUnit": "Kg",
  "treatment": {
    "id": 0,
    "name": "string",
    "type": "Inbound",
    "sigreRef": "string"
  },
  "environmentalLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  }
}

OperationalUnitType

Type: enum (string)

Values:

  • Base
  • Vessel

OrderModel

Type: object

Field Type Required Description
id integer (int64) No
status OrderStatus No
customer GeneratorModel No
operationalUnit OperationalUnitModel No
periodOfDay PeriodOfDay No
observation string No (nullable)
executionDate string (date-time) No
transporter VendorModel No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "status": "Scheduled",
  "customer": {
    "id": "string",
    "name": "string",
    "cnpj": "string"
  },
  "operationalUnit": {
    "id": 0,
    "type": "Base",
    "name": "string",
    "acronym": "string",
    "location": {
      "id": 0,
      "name": "string",
      "distanceUtr": 0,
      "enabled": true
    },
    "vesselType": "string",
    "treatmentPreferences": [
      {
        "id": 0,
        "residue": {
          "id": "...",
          "code": "...",
          "name": "...",
          "sigreRef": "...",
          "totalSaRef": "...",
          "isChemicalProduct": "...",
          "conamaColor": "...",
          "classification": "...",
          "phisicalState": "...",
          "nameCompositions": "...",
          "observation": "...",
          "petrobrasPackagingPlace": "...",
          "petrobrasDefaultPackagingType": "...",
          "inboundEnvironmentalLicense": "..."
        },
        "measuringUnit": "Kg",
        "treatment": {
          "id": "...",
          "name": "...",
          "type": "...",
          "sigreRef": "..."
        },
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        }
      }
    ],
    "petrobrasName": "string",
    "petrobrasManagement": "string",
    "regionNtIbamaIdxPetrobras": 0,
    "petrobrasGenerationPlace": "string",
    "petrobrasPackagingType": "string"
  },
  "periodOfDay": "Morning",
  "observation": "string",
  "executionDate": "2024-01-15T10:30:00Z",
  "transporter": {
    "id": "string",
    "name": "string",
    "cnpj": "string",
    "isTransporter": true,
    "isReceiver": true
  },
  "documentUrl": "string"
}

OrderStatus

Type: enum (string)

Values:

  • Scheduled
  • Started
  • Completed
  • Cancelled
  • Rescheduled

OutboundBatchModel

Type: object

Field Type Required Description
id integer (int64) No
issuedDate string (date-time) No
residue ResidueModel No
outboundManifest OutboundManifestModel No
outboundCdf OutboundCdfModel No
treatment TreatmentModel No
transporterLicense EnvironmentalLicenseModel No
receiverLicense EnvironmentalLicenseModel No

Example:

{
  "id": 0,
  "issuedDate": "2024-01-15T10:30:00Z",
  "residue": {
    "id": 0,
    "code": "string",
    "name": "string",
    "sigreRef": "string",
    "totalSaRef": "string",
    "isChemicalProduct": true,
    "conamaColor": "Orange",
    "classification": "ClassI",
    "phisicalState": "Solid",
    "nameCompositions": [
      {
        "id": 0,
        "name": "string",
        "code": "string",
        "resolution": "Nbr10004"
      }
    ],
    "observation": "string",
    "petrobrasPackagingPlace": "string",
    "petrobrasDefaultPackagingType": "string",
    "inboundEnvironmentalLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  },
  "outboundManifest": {
    "id": 0,
    "outboundBatchId": 0,
    "number": "string",
    "residue": {
      "id": 0,
      "code": "string",
      "name": "string",
      "sigreRef": "string",
      "totalSaRef": "string",
      "isChemicalProduct": true,
      "conamaColor": "Orange",
      "classification": "ClassI",
      "phisicalState": "Solid",
      "nameCompositions": [
        {
          "id": "...",
          "name": "...",
          "code": "...",
          "resolution": "..."
        }
      ],
      "observation": "string",
      "petrobrasPackagingPlace": "string",
      "petrobrasDefaultPackagingType": "string",
      "inboundEnvironmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      }
    },
    "residueNameComplement": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "quantity": 0.0,
    "measuringUnit": "Kg",
    "treatment": {
      "id": 0,
      "name": "string",
      "type": "Inbound",
      "sigreRef": "string"
    },
    "packaging": {
      "id": 0,
      "name": "string",
      "sigreRef": "string"
    },
    "generatorLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "transporterLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "driverName": "string",
    "vehiclePlate": "string",
    "receiverLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "observation": "string",
    "conclusionTimestamp": "2024-01-15T10:30:00Z",
    "documentUrl": "string"
  },
  "outboundCdf": {
    "id": 0,
    "outboundBatchId": 0,
    "receiver": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "inclusionDate": "2024-01-15T10:30:00Z",
    "periodStart": "2024-01-15T10:30:00Z",
    "periodEnd": "2024-01-15T10:30:00Z",
    "cdfType": "Transforma",
    "documentUrl": "string"
  },
  "treatment": {
    "id": 0,
    "name": "string",
    "type": "Inbound",
    "sigreRef": "string"
  },
  "transporterLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "receiverLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  }
}

OutboundCdfModel

Type: object

Field Type Required Description
id integer (int64) No
outboundBatchId integer (int64) No (nullable)
receiver VendorModel No
number string No (nullable)
issuedDate string (date-time) No
inclusionDate string (date-time) No
periodStart string (date-time) No (nullable)
periodEnd string (date-time) No (nullable)
cdfType CdfType No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "outboundBatchId": 0,
  "receiver": {
    "id": "string",
    "name": "string",
    "cnpj": "string",
    "isTransporter": true,
    "isReceiver": true
  },
  "number": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "inclusionDate": "2024-01-15T10:30:00Z",
  "periodStart": "2024-01-15T10:30:00Z",
  "periodEnd": "2024-01-15T10:30:00Z",
  "cdfType": "Transforma",
  "documentUrl": "string"
}

OutboundManifestModel

Type: object

Field Type Required Description
id integer (int64) No
outboundBatchId integer (int64) No (nullable)
number string No (nullable)
residue ResidueModel No
residueNameComplement string No (nullable)
issuedDate string (date-time) No
quantity number (double) No (nullable)
measuringUnit MeasuringUnit No
treatment TreatmentModel No
packaging PackagingModel No
generatorLicense EnvironmentalLicenseModel No
transporterLicense EnvironmentalLicenseModel No
driverName string No (nullable)
vehiclePlate string No (nullable)
receiverLicense EnvironmentalLicenseModel No
observation string No (nullable)
conclusionTimestamp string (date-time) No
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "outboundBatchId": 0,
  "number": "string",
  "residue": {
    "id": 0,
    "code": "string",
    "name": "string",
    "sigreRef": "string",
    "totalSaRef": "string",
    "isChemicalProduct": true,
    "conamaColor": "Orange",
    "classification": "ClassI",
    "phisicalState": "Solid",
    "nameCompositions": [
      {
        "id": 0,
        "name": "string",
        "code": "string",
        "resolution": "Nbr10004"
      }
    ],
    "observation": "string",
    "petrobrasPackagingPlace": "string",
    "petrobrasDefaultPackagingType": "string",
    "inboundEnvironmentalLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  },
  "residueNameComplement": "string",
  "issuedDate": "2024-01-15T10:30:00Z",
  "quantity": 0.0,
  "measuringUnit": "Kg",
  "treatment": {
    "id": 0,
    "name": "string",
    "type": "Inbound",
    "sigreRef": "string"
  },
  "packaging": {
    "id": 0,
    "name": "string",
    "sigreRef": "string"
  },
  "generatorLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "transporterLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "driverName": "string",
  "vehiclePlate": "string",
  "receiverLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  },
  "observation": "string",
  "conclusionTimestamp": "2024-01-15T10:30:00Z",
  "documentUrl": "string"
}

PackagingModel

Type: object

Field Type Required Description
id integer (int64) No
name string No (nullable)
sigreRef string No (nullable)

Example:

{
  "id": 0,
  "name": "string",
  "sigreRef": "string"
}

PeriodOfDay

Type: enum (string)

Values:

  • Morning
  • Afternoon
  • Night

PortModel

Type: object

Field Type Required Description
id integer (int64) No
name string No (nullable)
distanceToUtrInKm integer (int32) No (nullable)
location LocationModel No
enabled boolean No
address string No (nullable)
regionNtIbamaIdxPetrobras integer (int32) No (nullable)
petrobrasName string No (nullable)

Example:

{
  "id": 0,
  "name": "string",
  "distanceToUtrInKm": 0,
  "location": {
    "id": 0,
    "name": "string",
    "distanceUtr": 0,
    "enabled": true
  },
  "enabled": true,
  "address": "string",
  "regionNtIbamaIdxPetrobras": 0,
  "petrobrasName": "string"
}

ProblemDetails

Type: object

Field Type Required Description
type string No (nullable)
title string No (nullable)
status integer (int32) No (nullable)
detail string No (nullable)
instance string No (nullable)

Example:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

ResidueClassification

Type: enum (string)

Values:

  • ClassI
  • Class2A
  • Class2B
  • GroupA
  • GroupB_K1
  • GroupC
  • GroupD
  • GroupE

ResidueModel

Type: object

Field Type Required Description
id integer (int64) No
code string No (nullable)
name string No (nullable)
sigreRef string No (nullable)
totalSaRef string No (nullable)
isChemicalProduct boolean No (nullable)
conamaColor ConamaColor No
classification ResidueClassification No
phisicalState ResidueState No
nameCompositions array\<ResidueNameCompositionModel> No (nullable)
observation string No (nullable)
petrobrasPackagingPlace string No (nullable)
petrobrasDefaultPackagingType string No (nullable)
inboundEnvironmentalLicense EnvironmentalLicenseModel No

Example:

{
  "id": 0,
  "code": "string",
  "name": "string",
  "sigreRef": "string",
  "totalSaRef": "string",
  "isChemicalProduct": true,
  "conamaColor": "Orange",
  "classification": "ClassI",
  "phisicalState": "Solid",
  "nameCompositions": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "resolution": "Nbr10004"
    }
  ],
  "observation": "string",
  "petrobrasPackagingPlace": "string",
  "petrobrasDefaultPackagingType": "string",
  "inboundEnvironmentalLicense": {
    "id": 0,
    "vendor": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "description": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "expirationDate": "2024-01-15T10:30:00Z",
    "licenseType": "Operation",
    "licenseActivity": "Receiver",
    "renewalProtocols": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "annotations": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "supplementaryDocuments": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "number": "string",
        "description": "string",
        "type": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "enabled": true,
        "documentUrl": "string"
      }
    ],
    "licensePortSigres": [
      {
        "id": 0,
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "port": {
          "id": "...",
          "name": "...",
          "distanceToUtrInKm": "...",
          "location": "...",
          "enabled": "...",
          "address": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasName": "..."
        },
        "receiverSigreText": "string"
      }
    ],
    "licensedActivitiesCode": "string",
    "scope": "string",
    "organ": "string",
    "state": "string",
    "observation": "string",
    "enabled": true,
    "defaultDisposingVendorSigre": "string",
    "documentUrl": "string"
  }
}

ResidueNameCompositionModel

Type: object

Field Type Required Description
id integer (int64) No
name string No (nullable)
code string No (nullable)
resolution ResidueResolution No

Example:

{
  "id": 0,
  "name": "string",
  "code": "string",
  "resolution": "Nbr10004"
}

ResidueResolution

Type: enum (string)

Values:

  • Nbr10004
  • Ibama
  • Petrobras
  • OnDemand

ResidueState

Type: enum (string)

Values:

  • Solid
  • Semisolid
  • Liquid

RoModel

Type: object

Field Type Required Description
id integer (int64) No
number string No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "number": "string",
  "documentUrl": "string"
}

RtModel

Type: object

Field Type Required Description
id integer (int64) No
number string No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "number": "string",
  "documentUrl": "string"
}

TreatmentModel

Type: object

Field Type Required Description
id integer (int64) No
name string No (nullable)
type TreatmentType No
sigreRef string No (nullable)

Example:

{
  "id": 0,
  "name": "string",
  "type": "Inbound",
  "sigreRef": "string"
}

TreatmentType

Type: enum (string)

Values:

  • Inbound
  • Outbound
  • Both

VendorModel

Type: object

Field Type Required Description
id string No (nullable)
name string No (nullable)
cnpj string No (nullable)
isTransporter boolean No (nullable)
isReceiver boolean No (nullable)

Example:

{
  "id": "string",
  "name": "string",
  "cnpj": "string",
  "isTransporter": true,
  "isReceiver": true
}

VendorType

Type: enum (string)

Values:

  • OnlyReceiver
  • OnlyTransporter
  • ReceiverAndTransporter

WasteTrackingItemModel

Type: object

Field Type Required Description
id integer (int64) No
customer GeneratorModel No
operationalUnit OperationalUnitModel No
residue ResidueModel No
weighing WeighingModel No
order OrderModel No
inboundManifest InboundManifestModel No
outboundManifest OutboundManifestModel No
ineaReceptionReport IneaReceptionReportModel No
ineaCdf IneaCdfModel No
outboundBatch OutboundBatchModel No
fcdr FcdrModel No
ro RoModel No
rt RtModel No
drillship string No (nullable)
trellis string No (nullable)
orderIsUploaded boolean No
inboundManifestIsUploaded boolean No
outboundManifestIsUploaded boolean No
cdfIsUploaded boolean No
fcdrIsUploaded boolean No
customerId string No (nullable)

Example:

{
  "id": 0,
  "customer": {
    "id": "string",
    "name": "string",
    "cnpj": "string"
  },
  "operationalUnit": {
    "id": 0,
    "type": "Base",
    "name": "string",
    "acronym": "string",
    "location": {
      "id": 0,
      "name": "string",
      "distanceUtr": 0,
      "enabled": true
    },
    "vesselType": "string",
    "treatmentPreferences": [
      {
        "id": 0,
        "residue": {
          "id": "...",
          "code": "...",
          "name": "...",
          "sigreRef": "...",
          "totalSaRef": "...",
          "isChemicalProduct": "...",
          "conamaColor": "...",
          "classification": "...",
          "phisicalState": "...",
          "nameCompositions": "...",
          "observation": "...",
          "petrobrasPackagingPlace": "...",
          "petrobrasDefaultPackagingType": "...",
          "inboundEnvironmentalLicense": "..."
        },
        "measuringUnit": "Kg",
        "treatment": {
          "id": "...",
          "name": "...",
          "type": "...",
          "sigreRef": "..."
        },
        "environmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        }
      }
    ],
    "petrobrasName": "string",
    "petrobrasManagement": "string",
    "regionNtIbamaIdxPetrobras": 0,
    "petrobrasGenerationPlace": "string",
    "petrobrasPackagingType": "string"
  },
  "residue": {
    "id": 0,
    "code": "string",
    "name": "string",
    "sigreRef": "string",
    "totalSaRef": "string",
    "isChemicalProduct": true,
    "conamaColor": "Orange",
    "classification": "ClassI",
    "phisicalState": "Solid",
    "nameCompositions": [
      {
        "id": 0,
        "name": "string",
        "code": "string",
        "resolution": "Nbr10004"
      }
    ],
    "observation": "string",
    "petrobrasPackagingPlace": "string",
    "petrobrasDefaultPackagingType": "string",
    "inboundEnvironmentalLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  },
  "weighing": {
    "id": 0,
    "weighingTimestamp": "2024-01-15T10:30:00Z",
    "weighRegistrationTimestamp": "2024-01-15T10:30:00Z",
    "inventoryDate": "2024-01-15T10:30:00Z",
    "status": "Weighed",
    "gross": 0.0,
    "tare": 0.0,
    "net": 0.0,
    "convertedInUnits": 0.0,
    "convertedInCubicMeters": 0.0,
    "observation": "string",
    "cancellationReason": "string",
    "equipmentNumber": "string",
    "fiscalDocumentNumber": "string",
    "documentUrl": "string"
  },
  "order": {
    "id": 0,
    "status": "Scheduled",
    "customer": {
      "id": "string",
      "name": "string",
      "cnpj": "string"
    },
    "operationalUnit": {
      "id": 0,
      "type": "Base",
      "name": "string",
      "acronym": "string",
      "location": {
        "id": 0,
        "name": "string",
        "distanceUtr": 0,
        "enabled": true
      },
      "vesselType": "string",
      "treatmentPreferences": [
        {
          "id": "...",
          "residue": "...",
          "measuringUnit": "...",
          "treatment": "...",
          "environmentalLicense": "..."
        }
      ],
      "petrobrasName": "string",
      "petrobrasManagement": "string",
      "regionNtIbamaIdxPetrobras": 0,
      "petrobrasGenerationPlace": "string",
      "petrobrasPackagingType": "string"
    },
    "periodOfDay": "Morning",
    "observation": "string",
    "executionDate": "2024-01-15T10:30:00Z",
    "transporter": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "documentUrl": "string"
  },
  "inboundManifest": {
    "id": 0,
    "number": "string",
    "residue": {
      "id": 0,
      "code": "string",
      "name": "string",
      "sigreRef": "string",
      "totalSaRef": "string",
      "isChemicalProduct": true,
      "conamaColor": "Orange",
      "classification": "ClassI",
      "phisicalState": "Solid",
      "nameCompositions": [
        {
          "id": "...",
          "name": "...",
          "code": "...",
          "resolution": "..."
        }
      ],
      "observation": "string",
      "petrobrasPackagingPlace": "string",
      "petrobrasDefaultPackagingType": "string",
      "inboundEnvironmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      }
    },
    "residueNameComplement": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "quantity": 0.0,
    "measuringUnit": "Kg",
    "treatment": {
      "id": 0,
      "name": "string",
      "type": "Inbound",
      "sigreRef": "string"
    },
    "packaging": {
      "id": 0,
      "name": "string",
      "sigreRef": "string"
    },
    "packagingIdentification": "string",
    "generatorLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "transporterLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "driverName": "string",
    "vehiclePlate": "string",
    "receiverLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "observation": "string",
    "receivingTimestamp": "2024-01-15T10:30:00Z",
    "conclusionTimestamp": "2024-01-15T10:30:00Z",
    "documentUrl": "string",
    "documentUrlCarbonCopies": "string"
  },
  "outboundManifest": {
    "id": 0,
    "outboundBatchId": 0,
    "number": "string",
    "residue": {
      "id": 0,
      "code": "string",
      "name": "string",
      "sigreRef": "string",
      "totalSaRef": "string",
      "isChemicalProduct": true,
      "conamaColor": "Orange",
      "classification": "ClassI",
      "phisicalState": "Solid",
      "nameCompositions": [
        {
          "id": "...",
          "name": "...",
          "code": "...",
          "resolution": "..."
        }
      ],
      "observation": "string",
      "petrobrasPackagingPlace": "string",
      "petrobrasDefaultPackagingType": "string",
      "inboundEnvironmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      }
    },
    "residueNameComplement": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "quantity": 0.0,
    "measuringUnit": "Kg",
    "treatment": {
      "id": 0,
      "name": "string",
      "type": "Inbound",
      "sigreRef": "string"
    },
    "packaging": {
      "id": 0,
      "name": "string",
      "sigreRef": "string"
    },
    "generatorLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "transporterLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "driverName": "string",
    "vehiclePlate": "string",
    "receiverLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "observation": "string",
    "conclusionTimestamp": "2024-01-15T10:30:00Z",
    "documentUrl": "string"
  },
  "ineaReceptionReport": {
    "id": 0,
    "conclusionTimestamp": "2024-01-15T10:30:00Z",
    "manifestNumber": "string",
    "receivingResponsible": "string",
    "documentUrl": "string"
  },
  "ineaCdf": {
    "id": 0,
    "receiver": {
      "id": "string",
      "name": "string",
      "cnpj": "string",
      "isTransporter": true,
      "isReceiver": true
    },
    "number": "string",
    "issuedDate": "2024-01-15T10:30:00Z",
    "inclusionDate": "2024-01-15T10:30:00Z",
    "periodStart": "2024-01-15T10:30:00Z",
    "periodEnd": "2024-01-15T10:30:00Z",
    "documentUrl": "string"
  },
  "outboundBatch": {
    "id": 0,
    "issuedDate": "2024-01-15T10:30:00Z",
    "residue": {
      "id": 0,
      "code": "string",
      "name": "string",
      "sigreRef": "string",
      "totalSaRef": "string",
      "isChemicalProduct": true,
      "conamaColor": "Orange",
      "classification": "ClassI",
      "phisicalState": "Solid",
      "nameCompositions": [
        {
          "id": "...",
          "name": "...",
          "code": "...",
          "resolution": "..."
        }
      ],
      "observation": "string",
      "petrobrasPackagingPlace": "string",
      "petrobrasDefaultPackagingType": "string",
      "inboundEnvironmentalLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      }
    },
    "outboundManifest": {
      "id": 0,
      "outboundBatchId": 0,
      "number": "string",
      "residue": {
        "id": 0,
        "code": "string",
        "name": "string",
        "sigreRef": "string",
        "totalSaRef": "string",
        "isChemicalProduct": true,
        "conamaColor": "Orange",
        "classification": "ClassI",
        "phisicalState": "Solid",
        "nameCompositions": [
          "..."
        ],
        "observation": "string",
        "petrobrasPackagingPlace": "string",
        "petrobrasDefaultPackagingType": "string",
        "inboundEnvironmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        }
      },
      "residueNameComplement": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "quantity": 0.0,
      "measuringUnit": "Kg",
      "treatment": {
        "id": 0,
        "name": "string",
        "type": "Inbound",
        "sigreRef": "string"
      },
      "packaging": {
        "id": 0,
        "name": "string",
        "sigreRef": "string"
      },
      "generatorLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "transporterLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "driverName": "string",
      "vehiclePlate": "string",
      "receiverLicense": {
        "id": 0,
        "vendor": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "description": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "expirationDate": "2024-01-15T10:30:00Z",
        "licenseType": "Operation",
        "licenseActivity": "Receiver",
        "renewalProtocols": [
          "..."
        ],
        "annotations": [
          "..."
        ],
        "supplementaryDocuments": [
          "..."
        ],
        "licensePortSigres": [
          "..."
        ],
        "licensedActivitiesCode": "string",
        "scope": "string",
        "organ": "string",
        "state": "string",
        "observation": "string",
        "enabled": true,
        "defaultDisposingVendorSigre": "string",
        "documentUrl": "string"
      },
      "observation": "string",
      "conclusionTimestamp": "2024-01-15T10:30:00Z",
      "documentUrl": "string"
    },
    "outboundCdf": {
      "id": 0,
      "outboundBatchId": 0,
      "receiver": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "inclusionDate": "2024-01-15T10:30:00Z",
      "periodStart": "2024-01-15T10:30:00Z",
      "periodEnd": "2024-01-15T10:30:00Z",
      "cdfType": "Transforma",
      "documentUrl": "string"
    },
    "treatment": {
      "id": 0,
      "name": "string",
      "type": "Inbound",
      "sigreRef": "string"
    },
    "transporterLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    },
    "receiverLicense": {
      "id": 0,
      "vendor": {
        "id": "string",
        "name": "string",
        "cnpj": "string",
        "isTransporter": true,
        "isReceiver": true
      },
      "number": "string",
      "description": "string",
      "issuedDate": "2024-01-15T10:30:00Z",
      "expirationDate": "2024-01-15T10:30:00Z",
      "licenseType": "Operation",
      "licenseActivity": "Receiver",
      "renewalProtocols": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "annotations": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "supplementaryDocuments": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "number": "...",
          "description": "...",
          "type": "...",
          "issuedDate": "...",
          "enabled": "...",
          "documentUrl": "..."
        }
      ],
      "licensePortSigres": [
        {
          "id": "...",
          "environmentalLicense": "...",
          "port": "...",
          "receiverSigreText": "..."
        }
      ],
      "licensedActivitiesCode": "string",
      "scope": "string",
      "organ": "string",
      "state": "string",
      "observation": "string",
      "enabled": true,
      "defaultDisposingVendorSigre": "string",
      "documentUrl": "string"
    }
  },
  "fcdr": {
    "id": 0,
    "number": "string",
    "date": "2024-01-15T10:30:00Z",
    "estimatedWeight": 0.0,
    "itemNumber": 0.0,
    "documentUrl": "string"
  },
  "ro": {
    "id": 0,
    "number": "string",
    "documentUrl": "string"
  },
  "rt": {
    "id": 0,
    "number": "string",
    "documentUrl": "string"
  },
  "drillship": "string",
  "trellis": "string",
  "orderIsUploaded": true,
  "inboundManifestIsUploaded": true,
  "outboundManifestIsUploaded": true,
  "cdfIsUploaded": true,
  "fcdrIsUploaded": true,
  "customerId": "string"
}

WasteTrackingItemModelPagedApiResponse

Type: object

Field Type Required Description
total integer (int32) No (nullable)
page integer (int32) No (nullable)
size integer (int32) No (nullable)
data array\<WasteTrackingItemModel> No (nullable)

Example:

{
  "total": 0,
  "page": 0,
  "size": 0,
  "data": [
    {
      "id": 0,
      "customer": {
        "id": "string",
        "name": "string",
        "cnpj": "string"
      },
      "operationalUnit": {
        "id": 0,
        "type": "Base",
        "name": "string",
        "acronym": "string",
        "location": {
          "id": "...",
          "name": "...",
          "distanceUtr": "...",
          "enabled": "..."
        },
        "vesselType": "string",
        "treatmentPreferences": [
          "..."
        ],
        "petrobrasName": "string",
        "petrobrasManagement": "string",
        "regionNtIbamaIdxPetrobras": 0,
        "petrobrasGenerationPlace": "string",
        "petrobrasPackagingType": "string"
      },
      "residue": {
        "id": 0,
        "code": "string",
        "name": "string",
        "sigreRef": "string",
        "totalSaRef": "string",
        "isChemicalProduct": true,
        "conamaColor": "Orange",
        "classification": "ClassI",
        "phisicalState": "Solid",
        "nameCompositions": [
          "..."
        ],
        "observation": "string",
        "petrobrasPackagingPlace": "string",
        "petrobrasDefaultPackagingType": "string",
        "inboundEnvironmentalLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        }
      },
      "weighing": {
        "id": 0,
        "weighingTimestamp": "2024-01-15T10:30:00Z",
        "weighRegistrationTimestamp": "2024-01-15T10:30:00Z",
        "inventoryDate": "2024-01-15T10:30:00Z",
        "status": "Weighed",
        "gross": 0.0,
        "tare": 0.0,
        "net": 0.0,
        "convertedInUnits": 0.0,
        "convertedInCubicMeters": 0.0,
        "observation": "string",
        "cancellationReason": "string",
        "equipmentNumber": "string",
        "fiscalDocumentNumber": "string",
        "documentUrl": "string"
      },
      "order": {
        "id": 0,
        "status": "Scheduled",
        "customer": {
          "id": "...",
          "name": "...",
          "cnpj": "..."
        },
        "operationalUnit": {
          "id": "...",
          "type": "...",
          "name": "...",
          "acronym": "...",
          "location": "...",
          "vesselType": "...",
          "treatmentPreferences": "...",
          "petrobrasName": "...",
          "petrobrasManagement": "...",
          "regionNtIbamaIdxPetrobras": "...",
          "petrobrasGenerationPlace": "...",
          "petrobrasPackagingType": "..."
        },
        "periodOfDay": "Morning",
        "observation": "string",
        "executionDate": "2024-01-15T10:30:00Z",
        "transporter": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "documentUrl": "string"
      },
      "inboundManifest": {
        "id": 0,
        "number": "string",
        "residue": {
          "id": "...",
          "code": "...",
          "name": "...",
          "sigreRef": "...",
          "totalSaRef": "...",
          "isChemicalProduct": "...",
          "conamaColor": "...",
          "classification": "...",
          "phisicalState": "...",
          "nameCompositions": "...",
          "observation": "...",
          "petrobrasPackagingPlace": "...",
          "petrobrasDefaultPackagingType": "...",
          "inboundEnvironmentalLicense": "..."
        },
        "residueNameComplement": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "quantity": 0.0,
        "measuringUnit": "Kg",
        "treatment": {
          "id": "...",
          "name": "...",
          "type": "...",
          "sigreRef": "..."
        },
        "packaging": {
          "id": "...",
          "name": "...",
          "sigreRef": "..."
        },
        "packagingIdentification": "string",
        "generatorLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "transporterLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "driverName": "string",
        "vehiclePlate": "string",
        "receiverLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "observation": "string",
        "receivingTimestamp": "2024-01-15T10:30:00Z",
        "conclusionTimestamp": "2024-01-15T10:30:00Z",
        "documentUrl": "string",
        "documentUrlCarbonCopies": "string"
      },
      "outboundManifest": {
        "id": 0,
        "outboundBatchId": 0,
        "number": "string",
        "residue": {
          "id": "...",
          "code": "...",
          "name": "...",
          "sigreRef": "...",
          "totalSaRef": "...",
          "isChemicalProduct": "...",
          "conamaColor": "...",
          "classification": "...",
          "phisicalState": "...",
          "nameCompositions": "...",
          "observation": "...",
          "petrobrasPackagingPlace": "...",
          "petrobrasDefaultPackagingType": "...",
          "inboundEnvironmentalLicense": "..."
        },
        "residueNameComplement": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "quantity": 0.0,
        "measuringUnit": "Kg",
        "treatment": {
          "id": "...",
          "name": "...",
          "type": "...",
          "sigreRef": "..."
        },
        "packaging": {
          "id": "...",
          "name": "...",
          "sigreRef": "..."
        },
        "generatorLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "transporterLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "driverName": "string",
        "vehiclePlate": "string",
        "receiverLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "observation": "string",
        "conclusionTimestamp": "2024-01-15T10:30:00Z",
        "documentUrl": "string"
      },
      "ineaReceptionReport": {
        "id": 0,
        "conclusionTimestamp": "2024-01-15T10:30:00Z",
        "manifestNumber": "string",
        "receivingResponsible": "string",
        "documentUrl": "string"
      },
      "ineaCdf": {
        "id": 0,
        "receiver": {
          "id": "...",
          "name": "...",
          "cnpj": "...",
          "isTransporter": "...",
          "isReceiver": "..."
        },
        "number": "string",
        "issuedDate": "2024-01-15T10:30:00Z",
        "inclusionDate": "2024-01-15T10:30:00Z",
        "periodStart": "2024-01-15T10:30:00Z",
        "periodEnd": "2024-01-15T10:30:00Z",
        "documentUrl": "string"
      },
      "outboundBatch": {
        "id": 0,
        "issuedDate": "2024-01-15T10:30:00Z",
        "residue": {
          "id": "...",
          "code": "...",
          "name": "...",
          "sigreRef": "...",
          "totalSaRef": "...",
          "isChemicalProduct": "...",
          "conamaColor": "...",
          "classification": "...",
          "phisicalState": "...",
          "nameCompositions": "...",
          "observation": "...",
          "petrobrasPackagingPlace": "...",
          "petrobrasDefaultPackagingType": "...",
          "inboundEnvironmentalLicense": "..."
        },
        "outboundManifest": {
          "id": "...",
          "outboundBatchId": "...",
          "number": "...",
          "residue": "...",
          "residueNameComplement": "...",
          "issuedDate": "...",
          "quantity": "...",
          "measuringUnit": "...",
          "treatment": "...",
          "packaging": "...",
          "generatorLicense": "...",
          "transporterLicense": "...",
          "driverName": "...",
          "vehiclePlate": "...",
          "receiverLicense": "...",
          "observation": "...",
          "conclusionTimestamp": "...",
          "documentUrl": "..."
        },
        "outboundCdf": {
          "id": "...",
          "outboundBatchId": "...",
          "receiver": "...",
          "number": "...",
          "issuedDate": "...",
          "inclusionDate": "...",
          "periodStart": "...",
          "periodEnd": "...",
          "cdfType": "...",
          "documentUrl": "..."
        },
        "treatment": {
          "id": "...",
          "name": "...",
          "type": "...",
          "sigreRef": "..."
        },
        "transporterLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        },
        "receiverLicense": {
          "id": "...",
          "vendor": "...",
          "number": "...",
          "description": "...",
          "issuedDate": "...",
          "expirationDate": "...",
          "licenseType": "...",
          "licenseActivity": "...",
          "renewalProtocols": "...",
          "annotations": "...",
          "supplementaryDocuments": "...",
          "licensePortSigres": "...",
          "licensedActivitiesCode": "...",
          "scope": "...",
          "organ": "...",
          "state": "...",
          "observation": "...",
          "enabled": "...",
          "defaultDisposingVendorSigre": "...",
          "documentUrl": "..."
        }
      },
      "fcdr": {
        "id": 0,
        "number": "string",
        "date": "2024-01-15T10:30:00Z",
        "estimatedWeight": 0.0,
        "itemNumber": 0.0,
        "documentUrl": "string"
      },
      "ro": {
        "id": 0,
        "number": "string",
        "documentUrl": "string"
      },
      "rt": {
        "id": 0,
        "number": "string",
        "documentUrl": "string"
      },
      "drillship": "string",
      "trellis": "string",
      "orderIsUploaded": true,
      "inboundManifestIsUploaded": true,
      "outboundManifestIsUploaded": true,
      "cdfIsUploaded": true,
      "fcdrIsUploaded": true,
      "customerId": "string"
    }
  ]
}

WeighingModel

Type: object

Field Type Required Description
id integer (int64) No
weighingTimestamp string (date-time) No
weighRegistrationTimestamp string (date-time) No
inventoryDate string (date-time) No
status WeighingStatus No
gross number (double) No (nullable)
tare number (double) No (nullable)
net number (double) No (nullable)
convertedInUnits number (double) No (nullable)
convertedInCubicMeters number (double) No (nullable)
observation string No (nullable)
cancellationReason string No (nullable)
equipmentNumber string No (nullable)
fiscalDocumentNumber string No (nullable)
documentUrl string No (nullable, read-only)

Example:

{
  "id": 0,
  "weighingTimestamp": "2024-01-15T10:30:00Z",
  "weighRegistrationTimestamp": "2024-01-15T10:30:00Z",
  "inventoryDate": "2024-01-15T10:30:00Z",
  "status": "Weighed",
  "gross": 0.0,
  "tare": 0.0,
  "net": 0.0,
  "convertedInUnits": 0.0,
  "convertedInCubicMeters": 0.0,
  "observation": "string",
  "cancellationReason": "string",
  "equipmentNumber": "string",
  "fiscalDocumentNumber": "string",
  "documentUrl": "string"
}

WeighingStatus

Type: enum (string)

Values:

  • Weighed
  • Released
  • Measured
  • Frozen
  • Cancelled
  • Internal