Get International Consignment Note Fields

from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.international_consignment_note.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.international_consignment_note is not None

    # Handle response
    print(res.international_consignment_note)

{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "international-consignment-note",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "shipper": {
      "name": "Global Exports Ltd",
      "address": "123 Business Park, London, UK EC2A 4PB",
      "country": "United Kingdom",
      "stateOrProvince": "England",
      "city": "London",
      "postalCode": "EC2A 4PB",
      "street": "123 Business Park",
      "signatureAndStamp": "Signed and stamped by Global Exports Ltd"
    },
    "consignee": {
      "name": "US Imports Inc",
      "address": "456 Trade Street, New York, NY 10001",
      "country": "United States",
      "stateOrProvince": "New York",
      "city": "New York",
      "postalCode": "10001",
      "street": "456 Trade Street",
      "signatureAndStamp": "Signed and stamped by US Imports Inc"
    },
    "carrier": {
      "name": "International Freight Services",
      "address": "789 Transport Ave, London, UK EC2A 4PC",
      "country": "United Kingdom",
      "stateOrProvince": "England",
      "city": "London",
      "postalCode": "EC2A 4PC",
      "street": "789 Transport Ave",
      "signatureAndStamp": "Signed and stamped by IFS"
    },
    "successiveCarrier": {
      "name": "US Transport Co",
      "address": "321 Logistics Blvd, New York, NY 10002",
      "country": "United States",
      "stateOrProvince": "New York",
      "city": "New York",
      "postalCode": "10002",
      "street": "321 Logistics Blvd"
    },
    "placeOfDeliveryOfGoods": {
      "address": "456 Trade Street, New York, NY 10001",
      "country": "United States"
    },
    "placeAndDateOfTakingOverOfGoods": {
      "address": "123 Business Park, London, UK EC2A 4PB",
      "country": "United Kingdom",
      "date": "2024-03-15"
    },
    "listOfAnnexedDocuments": [
      "Invoice",
      "Packing List",
      "Certificate of Origin"
    ],
    "lineItems": [
      {
        "marksAndNumbers": "PKG-001",
        "numberOfPackages": 10,
        "typeOfPackaging": "Pallet",
        "natureOfGoods": "Industrial Machinery",
        "hsCode": "848330",
        "grossWeight": 1000,
        "weightUom": "kg",
        "volume": 5,
        "volumeUom": "m3"
      }
    ],
    "totals": {
      "totalNumberOfPackages": 10,
      "totalPackagesUom": "Pallet",
      "totalWeight": 1000,
      "totalWeightUom": "kg",
      "totalVolume": 5,
      "totalVolumeUom": "m3"
    },
    "documentNumber": "CMR-2024-001",
    "placeOfIssue": "London",
    "dateOfIssue": "2024-03-15",
    "loading": {
      "arrivalDate": "2024-03-15",
      "arrivalTime": "09:00:00",
      "departureDate": "2024-03-15",
      "departureTime": "11:00:00"
    },
    "discharge": {
      "arrivalDate": "2024-03-20",
      "arrivalTime": "14:00:00",
      "departureDate": "2024-03-20",
      "departureTime": "16:00:00"
    },
    "termsOfDelivery": "DAP",
    "valueOfGoods": 50000,
    "currency": "USD",
    "sendersInstructions": "Handle with care, temperature controlled",
    "carrierRemarks": "Goods in good condition",
    "specialAgreementsOfCarriage": "Temperature controlled transport required",
    "numberPlate": "UK-12345",
    "trailerNumberPlate": "UK-67890",
    "goodsReceivedDate": "2024-03-15"
  }
}