Skip to main content

Party Schema

Represents an exporter, importer, or notify party.

Fields

FieldTypeRequiredDescription
namestringYesCompany or individual name
addressstringYesStreet address
citystringYesCity
statestringNoState/province
postal_codestringNoPostal/ZIP code
countrystringYesISO 3166-1 alpha-2 country code
tax_idsobjectNoTax identification numbers (see below)
contact_emailstringNoEmail address
contact_phonestringNoPhone number

Tax IDs

FieldTypeDescription
einstringUS Employer Identification Number (XX-XXXXXXX)
eoristringEU/UK Economic Operators Registration (XX + up to 15 chars)
iecstringIndia Importer Exporter Code (10 alphanumeric)
gstinstringIndia GST Identification Number (15 alphanumeric)
vatstringEU VAT Number (country-specific)
panstringIndia Permanent Account Number (AAAAA9999A)
tinstringGeneric Tax Identification Number
abnstringAustralian Business Number (11 digits)

Example

{
"name": "Acme Corp",
"address": "123 Export Street",
"city": "Los Angeles",
"state": "CA",
"postal_code": "90001",
"country": "US",
"tax_ids": {
"ein": "12-3456789"
},
"contact_email": "export@acme.com",
"contact_phone": "+1-555-0100"
}