Get reference data

1

mailCategoryCd

string

The mail category code

a1

1

mailCategoryNm

string

The mail category name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

mailClassCd

string

The mail class code

a1

1

mailClassNm

string

The mail class name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

mailSubclassCd

string

The mail subclass code

a2

1

mailSubclassNm

string

The mail subclass name

an..64

1

mailClassCd

string

The mail class code

a1

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

conveyanceTypeCd

string

The conveyance type code

a1

1

conveyanceTypeNm

string

The conveyance type name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

productTypeCd

string

The product type code

a2

1

mailClassCd

string

The mail class code

a1

1

productTypeNm

string

The product type name

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

receptacleContentFormatCd

string

The receptacle content format code

a1

1

receptacleContentFormatNm

string

The receptacle content format name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

receptacleSubtypeCd

string

The receptacle type code

a2

1

receptacleSubtypeNm

string

The receptacle type name

an..64

1

receptacleTypeMaxWeight

number

The maximum allowed full weight for the receptacle type

n5.3

1

receptacleSubTypeWeight

number

The tare weight for the receptacle type

n5.3

1

parentRecetacleTypeCd

string

The parent receptacle type code

a2

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

1

sampleRateCd

string

The sample rate code for the receptacle type

a2

1

tareMinWeight

number

The minimum expected tare weight for the receptacle type

n5.3

1

tareMaxWeight

number

The maximum expected tare weight for the receptacle type

n5.3

1

receptacleCategoryCd

string

The category of receptacle type:

BG – Bag

CN – Container

PL – Pallet

TR - Tray

a2

2

languageCD

string

The language code for the translation

an..2

1

conditionCd

number

The condition code

0-255

1

conditionNm

string

The condition name

an..64

1

mailUnitTypeCd

string

The object type which the condition applies to.

AC - Internal air conveyance

AD - Accounting dispatch

AF - Accounting form

CL - Closed transit

CS - Consignment

CT - Container

DC - Domestic consignment

DD - Domestic dispatch

DP - Dispatch

DR - Domestic receptacle

ER - External receptacle

IB - Inner bag

IK - IPK - Item Per Kilo

LG - Leg

MI - Mail item

NP - New parcel bill rate

OT - Open transit letters

PC - International reply paid coupon

PR - Parcel bill rate

QY - Inquiry

RC - Receptacle

RS - Route schedule

SL - Sampling rule

SR - Sampled receptacle

TD - Terminal due

TI - Transport invoice

TL - Transport line

VN - Verification Note

a2

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

postalStatusCd

number

The postal status code

0-255

1

postalStatusNm

string

The postal status name

an..64

1

mailUnitTypeCd

string

The object type which the postal status applies to.

AC - Internal air conveyance

AD - Accounting dispatch

AF - Accounting form

CL - Closed transit

CS - Consignment

CT - Container

DC - Domestic consignment

DD - Domestic dispatch

DP - Dispatch

DR - Domestic receptacle

ER - External receptacle

IB - Inner bag

IK - IPK - Item Per Kilo

LG - Leg

MI - Mail item

NP - New parcel bill rate

OT - Open transit letters

PC - International reply paid coupon

PR - Parcel bill rate

QY - Inquiry

RC - Receptacle

RS - Route schedule

SL - Sampling rule

SR - Sampled receptacle

TD - Terminal due

TI - Transport invoice

TL - Transport line

VN - Verification Note

a2

1

postalStatusFCD

string

The postal status visible code

an4

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

serviceIndicatorMin

string

The start of the service indicator range

a2

1

serviceIndicatorMax

string

The end of the service indicator range

a2

1

mailClassCd

string

The mail class which mail items with identifier falling with the service indicator range belong to

a1

1

mailItemCategoryCd

string

The handling class which mail items with identifier falling with the service indicator range belong to

a2

1

conveyanceTypeCd

string

The conveyance type which mail items with identifier falling with the service indicator range have

a1

1

productTypeCd

string

The product type which mail items with identifier falling with the service indicator range belong to

a..1

1

mailitemContentCd

string

The type of content of mail items with identifier falling with the service indicator range

a..1

1

codIndicator

number

Whether or not mail items with identifier falling with the service indicator range are Cash on Delivery

0-1

1

eventTypeCd

number

The event type code

0-65535

1

eventTypeNm

string

The event type name

an..64

1

mailUnitTypeCd

string

The object type which the event type applies to.

AC - Internal air conveyance

AD - Accounting dispatch

AF - Accounting form

CL - Closed transit

CS - Consignment

CT - Container

DC - Domestic consignment

DD - Domestic dispatch

DP - Dispatch

DR - Domestic receptacle

ER - External receptacle

IB - Inner bag

IK - IPK - Item Per Kilo

LG - Leg

MI - Mail item

NP - New parcel bill rate

OT - Open transit letters

PC - International reply paid coupon

PR - Parcel bill rate

QY - Inquiry

RC - Receptacle

RS - Route schedule

SL - Sampling rule

SR - Sampled receptacle

TD - Terminal due

TI - Transport invoice

TL - Transport line

VN - Verification Note

a2

1

inboundOutboundInd

string

The mail flow which the event type applies to

I – Inbound

O – Outbound

N – Neutral

a1

1

resultStateIndCd

number

The object resulting state after the event occurs

0-65535

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

stateIndCd

number

The allowed initial states for the event to occur

0-65535

2

languageCD

string

The language code for the translation

an..2

1

stateIndCd

number

The state indicator code

0-65535

1

stateIndNm

string

The state indicator name

an..64

1

mailUnitTypeCd

string

The object type which the state indicator applies to.

AC - Internal air conveyance

AD - Accounting dispatch

AF - Accounting form

CL - Closed transit

CS - Consignment

CT - Container

DC - Domestic consignment

DD - Domestic dispatch

DP - Dispatch

DR - Domestic receptacle

ER - External receptacle

IB - Inner bag

IK - IPK - Item Per Kilo

LG - Leg

MI - Mail item

NP - New parcel bill rate

OT - Open transit letters

PC - International reply paid coupon

PR - Parcel bill rate

QY - Inquiry

RC - Receptacle

RS - Route schedule

SL - Sampling rule

SR - Sampled receptacle

TD - Terminal due

TI - Transport invoice

TL - Transport line

VN - Verification Note

a2

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

currencyCd

string

The currency code

an3

1

currencyNm

string

The currency name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

countryCd

string

The country code

an3

1

countryNm

string

The country name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

1

latitude

number

The country latitude

signed integer or empty

1

longitude

number

The country longitude

signed integer or empty

1

euEntranceDt

string

The date of country entry in the EU

YYYY-MM-DD or empty

2

languageCD

string

The language code for the translation

an..2

1

operatorCd

string

The operator code

an3

1

operatorLongNm

string

The operator long name

an..64

1

operatorShortNm

string

The operator short name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

1

paymentMethodCd

string

The pauyment method for the accounting with the operator

DR -

UP -

an2

1

emailAddress

string

The general email address for the operator

an..64

1

postalAddress

string

The general postal address for the operator

an..250

1

etoeSeparateInd

string

TBC

an1

1

numberSamplingDays

number

TBC

positive integer

1

airlineCd

string

The airline code

an..3

1

airlineNm

string

The airline name

an..64

1

officeFcd

string

The office code

an6

1

officeLongNm

string

The office long name

an..64

1

officeShortNm

string

The office short name

an..64

1

countryCd

string

The country where the office is located

a2

1

operatorCd

string

The postal operator which the office belongs to

a3

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

1

emailAddress

string

The general email address for the office

an..64

1

postalAddress

string

The general postal address for the office

an..250

1

restrictions

string

Free text restrictions for the office as defined in UPU Code List 108

an..512

1

validFrom

string

The date of validity start of the office

YYYY-MM-DD

1

validTo

string

The date of validity end of the office

YYYY-MM-DD or empty

1

dispatchesRoutedVia

string

Office from which consignments containing receptacles originating from the office are sent

an6 or empty

1

specialType

string

Special use of the office

<empty> - no special use

E – ETOE

M – Military mail facility

a1 or empty

1

bilateralAgreementRequired

number

Whether or not a bilateral agreement is required for sending mail to this office

0-1

2

mailFlowCd

string

The mail flow supported by the office

I – Inbound

O – Outbound

T – Transit

a1

2

mailCategoryCd

string

Mail category accepted by the office in inbound

a1

2

mailClassCd

string

Mail class accepted by the office in inbound

a1

2

mailCategoryCd

string

Mail category accepted by the office in outbound

a1

2

mailClassCd

string

Mail class accepted by the office in outbound

a1

1

locationFcd

string

The location code (country code + location code)

an5

1

countryCd

string

The country where the location is located

a2

1

locationCd

string

The location code (without country code)

a3

1

locationNm

string

The location name

an..64

1

locationStatusCd

string

The status of location

a2

1

suspendedInd

number

Whether the location is temporarily suspended

0-1

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

1

iataInd

number

1

latitude

number

The location latitude

signed integer or empty

1

longitude

number

The location longitude

signed integer or empty

1

cutoffAtOrigin

number

Number of minutes to load mail into a transport at this location

1

cutoffAtDestination

number

Number of minutes to offload mail from a transport at this location

1

minimumTransitTime

number

Number of minutes required to move mail from a transport to another at this location

1

locationTypeCd

string

The location type code

a1

1

locationTypeNm

string

The location type name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

locationStatusCd

string

The location status code

a1

1

locationStatusNm

string

The location status name

an..64

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

2

languageCD

string

The language code for the translation

an..2

1

ownOfficeCd

number

The office internal identifier

0-65535

1

ownOfficeFcd

string

The office code

an..25

1

ownOfficeNm

string

The office name

an..64

1

dbServerNm

string

The IPS databsase server where data for this office is located (in case of distributed IPS architecture)

an..32 or empty

1

validInd

number

0 – Official reference data (invalid)

1 - Official reference data (valid)

2 – Own reference data (invalid)

3 - Own reference data (valid)

n1

1

phoneNo

string

The phone number of the office

an..64

1

comments

string

Free text comments

an..256

1

houseNumber

string

The house number of the office address

an..30

1

addressLine1

string

Office address – line 1

an..105

1

addressLine2

string

Office address – line 2

an..105

1

postcode

string

Office postcode

an..17

1

city

string

Office city

an..32

1

customsOfficeCd

string

The customs office associated to the office

an..25

1

customsOfficeTypeCd

string

The type of customs office which the office is associated to

OE - At the office of exchange; default value

R - Remote Customs, i.e. Customs in the domestic network, no return to the Inward OE

ROE - Remote to the OE with return to the OE for injection into the domestic network

a..3

2

locationFcd

string

The locations which the office is linked to

a5

2

mailSubclassCd

string

Mail subclass supported by the office

a2

1

AccountingAgreementTypeCd

string

The accounting agreement type code

an..5

1

AccountingAgreementTypeNm

string

The accounting agreement type name

an..64

1

DefaultInd

number

Default indicator

n1

1

MailClassCd

string

The mail class which the agreement type applies to

a1

1

ProductTypeCd

string

The product type which the agreement type applies to

a1

1

ValidInd

number

Validity indicator

n1

2

languageCD

string

The language code for the translation

an..2

1

OperatorCd

1

AccountingAgreementTypeCd

string

The accounting agreement type code

an..5

1

ValidYearFrom

number

The validity start year for the agreement

n4

1

ValidYearTo

number

The validity end year for the agreement

n4

1

CurrencyCd

string

The currency used in accounting forms under this agreement

a3

1

RatesSdrInd

number

Whether rates used under this agreement are in XDR or in the same currency as the accounting forms

n1

1

EMailAddress

string

The email address used to communicate with the operator under this agreement

an..64

1

PostalAddress

string

The postal address used to communicate with the operator under this agreement

an..250

1

AccStageTypeCd

string

The accounting stage of the operator

an..3

1

QosParticipation

number

Whether there is Quality Of Service participation for this operator

n1

1

QosCompulsory

number

Percentage of the compulsory QoS participation

n3.n3

1

QosBonus

number

Percentage of the bonus QoS participation

n3.n3

1

WeightConfig

string

Bit map to define the use or net or gross weight for the REIMS letter accounting with this operator

an..255

1

BulkyIbrsStatus

number

Operator status in relation to Bulky IBRS (REIMS only)

n1

1

PredesAutoValidation

number

Whether PREDES 2.1 messages from this operator will be used to create validate accounting dispatch entries

n1

1

IbrsReimsMethodB

number

Whether IBRS mail is included or excluded from CN55/CN56/e55 for this operator

n1

1

BulkMailExcludedFromIacSent

number

Whether bulk mail is included or excluded from CN66/CN51 sent to this operator

n1

1

BulkMailExcludedFromIacReceived

number

Whether bulk mail is included or excluded from CN66/CN51 received from this operator

n1

1

ExcludeURandUXMailFromSampling

number

Exclude UR and UX dispatches sent by this operator from sampling

n1

1

DefaultCP94EcommerceRateStep

number

Default weight braket rate to be used in CP94 E-commerce for this operator

n1

1

SlitContentFormatInbound

number

Whether content format separation applies to dispatches received from this operator

n1

1

SplitContentFormatOutbound

number

Whether content format separation applies to dispatches sent to this operator

n1

1

PerformanceValueThreshold

number

EMS PfP threshold value (in %)

n3.n3

1

PerformanceValuePenalty

number

EMS PfP penalty value (in %)

n3.n3

1

DirectParcelsCurrencyCd

string

Currency for Interconnect accounting forms for direct parcels

a3

1

ReturnedParcelsCurrencyCd

string

Currency for Interconnect accounting forms for returned parcels

a3

1

AccountingStreamTypeID

number

The stream identifier

n..3

1

AccountingStreamTypeNm

string

The stream name

an..64

1

AccountingAgreementTypeCd

string

The accounting agreement type which the stream refers to

an..5

1

MailSubclassFCD

string

The mail subclass which the stream refers to

n2

1

ReceptacleSubTypeCd

string

The receptacle type which the stream refers to

an..5

1

ReceptacleContentFormatCd

string

The content format which the stream refers to

a1

1

MailItemCategoryCd

string

The mail item category which the stream refers to

a2

1

MailCharacCd

string

The mail characteristics which the stream refers to

TBC

1

RateConfig

string

The rate configuration for the stream

an..32

1

AccountingPeriodCd

string

The accounting period code

a1

1

AccountingPeriodNm

string

The accounting period name

an..32

2

languageCD

string

The language code for the translation

an..2

1

AccountingActionTypeCd

string

The accounting action type code

a1

1

AccountingActionTypNm

string

The accounting action type name

an..32

1

ValidInd

number

Valid indicator

n1

1

MailFlow

string

The mail flow which the accounting action type refers to

a1

1

MailCategoryCd

string

The mail category which the accounting action type refers to

a1

1

PeriodCd

string

The period type which the accounting action type refers to

a1

1

AccountingTypeCd

string

The accounting type which the accounting action type refers to

n3

1

MailClassCd

string

The mail class which the accounting action type refers to

a1

1

ProductTypeCd

string

The product type which the accounting action type refers to

a1

1

SupplementaryInd

number

Whether the accounting action supports supplementary forms generation

a1

2

languageCD

string

The language code for the translation

an..2

2

translation

string

The translated accounting action type name

an..128

2

AccountingFormTypeCd

string

The accounting form type associated to the accounting action

an..20

2

FormOrder

number

The execution order of the form type within the action

1-255

2

HasAdditionalCosts

string

Whether the form types allows manually specifying additional costs

a1

1

AccountingOperatorGroupCd

string

The accounting operator group code

an…6

1

AccountingOperatorGroupNm

string

The accounting operator group name

an..64

1

MailCategoryCd

string

The mail category of the dispatches allowed under this document capture partnership

a1

1

OriginOfficeFcd

string

The origin office of the dispatches allowed under this document capture partnership

a6

1

DestOfficeFcd

string

The destination office of the dispatches allowed under this document capture partnership

a6

1

MailClassCd

string

The mail class of the dispatches allowed under this document capture partnership

a1

1

MailSubclassCd

string

The mail subclass of the dispatches allowed under this document capture partnership

a2

1

ValidFrom

string

The validity start date for the partnership

YYYY-MM-DD

1

ValidTo

string

The validity end date for the partnership

YYYY-MM-DD

1

ScanRecInd

number

Whether receptacles in dispatches under this partnership contain barcoded labels

a1

1

VNReasonCd

string

The reason code

an2

1

VNReasonNm

string

The reason name

an..128

1

VNReasonCategoryCd

string

The reason category code

a1

1

ValidInd

number

Valid indicator

n1

1

DisplayAsOtherIrregularityOnCN43

string

Whether the reason shall be displayed as part of the Other irregularities on CN43 forms

a1

1

DisplayAsOtherIrregularityOnCP78

string

Whether the reason shall be displayed as part of the Other irregularities on CP78 forms

a1

1

DisplayAsOtherIrregularityOnE2

string

Whether the reason shall be displayed as part of the Other irregularities on E2 forms

a1

2

languageCD

string

The language code for the translation

an..2

1

VNReasonCategoryCd

string

The reason category code

a1

1

VnReasonCategoryNm

string

The reason category name

an..64

2

languageCD

string

The language code for the translation

an..2

1

AccountingStreamId

string

The accounting stream type which the rate applies to

n..3

1

OperatorCd

string

The operator which the rate applies to

an3

1

PartnerOfficeFcd

string

The partner office which the rate applies to

an6

1

OwnOfficeFcd

string

The own office which the rate applies to

an6

1

ConveyanceTypeCd

string

The conveyance type which the rate applies to

a1

1

MailFlow

string

The mail flow which the rate applies to

a1

1

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

1

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

1

MailCategoryCd

string

The mail category which the rate applies to

a1

1

ProductTypeCd

String

TBC

1

RateCriteriaCd

String

TBC

1

MultirateCriteriaPid

string

TBC

1

RateRevised

number

TBC

1

RateKg

number

The rate per kilogram

n..3.n4

1

RateItem

number

The rate per item

n..3.n4

1

LastModifiedDate

string

The date of last modification of the rate

YYYY-MM-DD

2

AccountingStreamId

string

The accounting stream type which the rate applies to

n..3

2

OperatorCd

string

The operator which the rate applies to

an3

2

PartnerOfficeFcd

string

The partner office which the rate applies to

an6

2

OwnOfficeFcd

string

The own office which the rate applies to

an6

2

ConveyanceTypeCd

string

The conveyance type which the rate applies to

a1

2

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

2

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

2

MailCategoryCd

string

The mail category which the rate applies to

a1

2

ProductTypeCd

String

TBC

2

RateCriteriaCd

String

TBC

2

MultirateCriteriaPid

string

TBC

2

RateRevised

number

TBC

2

RateKg

number

The rate per kilogram

n..3.n4

2

RateItem

number

The rate per item

n..3.n4

2

LastModifiedDate

string

The date of last modification of the rate

YYYY-MM-DDTHH:MM:SS.ms

2

Action

string

The type of action taken on the rate

Update or Delete

1

OperatorCd

string

The operator which the IPK applies to

an3

1

MailFlow

string

The mail flow which the IPK applies to

a1

1

Year

number

The year which the IPK applies to

n4

1

Period

string

The period (month, quarter, semester) which the IPK applies to

1-12

1

PeriodCd

string

The period type which the IPK applies to

a1

1

MailCategoryCd

string

The mail category which the IPK applies to

a1

1

MailSubclassCd

string

The mail subclass which the IPK applies to

a2

1

ReceptacleContentFormatCd

string

The content format which the IPK applies to

a1

1

ProductTypeCd

string

The product type which the IPK applies to

a1

1

OwnOfficeFcd

string

The own office which the IPK applies to

an6

1

PartnerOfficeFcd

string

The partner office which the IPK applies to

an6

1

ReceptacleSubTypeCd

string

The receptacle type which the IPK applies to

a2

1

AdjustmentNetGross

number

The gross-net adjustment

0.00001-1

1

SampleNet

number

The net weight sampled in the period which the IPS applies to

n12 (max 3 decimals)

1

SampleGross

number

The gross weight sampled in the period which the IPS applies to

n12 (max 3 decimals)

1

PProportion

number

The proportion of P format mail in X format mail

0.00001-100.00000

1

GProportion

number

The proportion of G format mail in X format mail

0.00001-100.00000

1

EProportion

number

The proportion of E format mail in X format mail

0.00001-100.00000

1

Ipk

number

The IPK value

n11 (max 5 decimals)

1

PIpk

number

The IPK value for P format mail

n11 (max 5 decimals)

1

GIpk

number

The IPK value for G format mail

n11 (max 5 decimals)

1

EIpk

number

The IPK value for E format mail

n11 (max 5 decimals)

1

ValidFrom

string

The validity start date of the IPK

YYYY-MM-DD

1

ValidTo

string

The validity end date of the IPK

YYYY-MM-DD

1

Comments

string

Free text comments

an..256

2

OperatorCd

string

The operator which the IPK applies to

an3

2

MailFlow

string

The mail flow which the IPK applies to

a1

2

Year

number

The year which the IPK applies to

n4

2

Period

string

The period (month, quarter, semester) which the IPK applies to

1-12

2

PeriodCd

string

The period type which the IPK applies to

a1

2

MailCategoryCd

string

The mail category which the IPK applies to

a1

2

MailSubclassCd

string

The mail subclass which the IPK applies to

a2

2

ReceptacleContentFormatCd

string

The content format which the IPK applies to

a1

2

ProductTypeCd

string

The product type which the IPK applies to

a1

2

OwnOfficeFcd

string

The own office which the IPK applies to

an6

2

PartnerOfficeFcd

string

The partner office which the IPK applies to

an6

2

ReceptacleSubTypeCd

string

The receptacle type which the IPK applies to

a2

2

AdjustmentNetGross

number

The gross-net adjustment

0.00001-1

2

SampleNet

number

The net weight sampled in the period which the IPS applies to

n12 (max 3 decimals)

2

SampleGross

number

The gross weight sampled in the period which the IPS applies to

n12 (max 3 decimals)

2

PProportion

number

The proportion of P format mail in X format mail

0.00001-100.00000

2

GProportion

number

The proportion of G format mail in X format mail

0.00001-100.00000

2

EProportion

number

The proportion of E format mail in X format mail

0.00001-100.00000

2

Ipk

number

The IPK value

n11 (max 5 decimals)

2

PIpk

number

The IPK value for P format mail

n11 (max 5 decimals)

2

GIpk

number

The IPK value for G format mail

n11 (max 5 decimals)

2

EIpk

number

The IPK value for E format mail

n11 (max 5 decimals)

2

ValidFrom

string

The validity start date of the IPK

YYYY-MM-DD

2

ValidTo

string

The validity end date of the IPK

YYYY-MM-DD

2

Comments

string

Free text comments

an..256

2

LastModifiedDate

string

The date of last modification of the IPK

YYYY-MM-DDTHH:MM:SS.ms

2

Action

string

The type of action taken on the IPK

Update or Delete

1

OperatorCd

string

The operator which the rate applies to

an3

1

CountryCd

string

The country which the rate applies to

an2

1

MailCategoryCd

string

The mail category which the rate applies to

a1

1

ProductTypeCd

string

The product type which the rate applies to

a1

1

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

1

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

1

Office

string

The office which the rate applies to

an6

1

MailFlow

string

The mail flow which the rate applies to

a1

1

Returned

number

Whether the rate only applies to returned parcels

n1

1

RateParcel

number

The inward land rate per parcel

n7 (max 4 decimals)

1

RateKg

number

The inward land rate per kilogram

n7 (max 4 decimals)

1

RateParcelBracket1

number

The inward land rate per parcel in bracket 1 (E-commercel parcels only)

n7 (max 4 decimals)

1

RateKg Bracket1

number

The inward land rate per kilogram in bracket 1 (E-commercel parcels only)

n7 (max 4 decimals)

1

RateParcelBracket2

number

The inward land rate per parcel in bracket 2 (E-commercel parcels only)

n7 (max 4 decimals)

1

RateKg Bracket2

number

The inward land rate per kilogram in bracket 2 (E-commercel parcels only)

n7 (max 4 decimals)

1

RateParcelBracket3

number

The inward land rate per parcel in bracket 3 (E-commercel parcels only)

n7 (max 4 decimals)

1

RateKg Bracket3

number

The inward land rate per kilogram in bracket 3 (E-commercel parcels only)

n7 (max 4 decimals)

1

TransitParcel

number

The transit rate per parcel

n7 (max 4 decimals)

1

TransitKg

number

The transit rate per kilogram

n7 (max 4 decimals)

1

Due1

number

The air conveyance charge (per half kilogram)

n7 (max 4 decimals)

1

CustomsParcel

number

The customs rate per parcel

n7 (max 4 decimals)

1

Observations

string

Free text comments

an..256

2

OperatorCd

string

The operator which the rate applies to

an3

2

CountryCd

string

The country which the rate applies to

an2

2

MailCategoryCd

string

The mail category which the rate applies to

a1

2

ProductTypeCd

string

The product type which the rate applies to

a1

2

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

2

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

2

Office

string

The office which the rate applies to

an6

2

MailFlow

string

The mail flow which the rate applies to

a1

2

Returned

number

Whether the rate only applies to returned parcels

n1

2

RateParcel

number

The inward land rate per parcel

n7 (max 4 decimals)

2

RateKg

number

The inward land rate per kilogram

n7 (max 4 decimals)

2

RateParcelBracket1

number

The inward land rate per parcel in bracket 1 (E-commercel parcels only)

n7 (max 4 decimals)

2

RateKg Bracket1

number

The inward land rate per kilogram in bracket 1 (E-commercel parcels only)

n7 (max 4 decimals)

2

RateParcelBracket2

number

The inward land rate per parcel in bracket 2 (E-commercel parcels only)

n7 (max 4 decimals)

2

RateKg Bracket2

number

The inward land rate per kilogram in bracket 2 (E-commercel parcels only)

n7 (max 4 decimals)

2

RateParcelBracket3

number

The inward land rate per parcel in bracket 3 (E-commercel parcels only)

n7 (max 4 decimals)

2

RateKg Bracket3

number

The inward land rate per kilogram in bracket 3 (E-commercel parcels only)

n7 (max 4 decimals)

2

TransitParcel

number

The transit rate per parcel

n7 (max 4 decimals)

2

TransitKg

number

The transit rate per kilogram

n7 (max 4 decimals)

2

Due1

number

The air conveyance charge (per half kilogram)

n7 (max 4 decimals)

2

CustomsParcel

number

The customs rate per parcel

n7 (max 4 decimals)

2

Observations

string

Free text comments

an..256

2

LastModifiedDate

string

The date of last modification of the rate

YYYY-MM-DDTHH:MM:SS.ms

2

Action

string

The type of action taken on the rate

Update or Delete

1

OperatorCd

string

The operator which the rate applies to

an3

1

OriginOfficeFcd

string

The origin office which the rate applies to

an6

1

DestinationOfficeFcd

string

The destination office which the rate applies to

an6

1

AccountingAgreementCd

string

The accounting agreement type which the rate applies to

an..5

1

ProductTypeCd

string

The product type which the rate applies to

a1

1

MailDirection

string

The mail flow which the rate applies to

a1

1

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

1

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

1

RateKg

number

The rate per kilogram

n7 (max 4 decimals)

2

OperatorCd

string

The operator which the rate applies to

an3

2

OriginOfficeFcd

string

The origin office which the rate applies to

an6

2

DestinationOfficeFcd

string

The destination office which the rate applies to

an6

2

AccountingAgreementCd

string

The accounting agreement type which the rate applies to

an..5

2

ProductTypeCd

string

The product type which the rate applies to

a1

2

MailDirection

string

The mail flow which the rate applies to

a1

2

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

2

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

2

RateKg

number

The rate per kilogram

n7 (max 4 decimals)

2

Action

string

The type of action taken on the rate

Update or Delete

1

TransitCountryCd

string

The transit operator which the rates and groups are defined for

an2

1

MailCategoryCd

string

The mail category which the rates and groups apply to

a1

2

GroupId

number

The group number

1-10

3

CountryCd

string

Code of the country in the group

an2

3

GroupNm

string

The name of the group charge

an..32

3

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

3

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

3

RateKg

number

The rate per kilogram

n7 (max 4 decimals)

4

GroupNm

string

The name of the group charge

4

ValidFrom

string

The validity start date of the rate

YYYY-MM-DD

4

ValidTo

string

The validity end date of the rate

YYYY-MM-DD

4

RateKg

number

The rate per kilogram

n7 (max 4 decimals)

4

Action

string

The type of action taken on the rate

Update or Delete