Retrieves the accounting agreement types defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AccountingAgreementTypes": [
- {
- "AccountingAgreementTypeCd": "LETR",
- "AccountingAgreementTypeNm": "Letters",
- "DefaultInd": 1,
- "MailClassCd": "U",
- "ProductTypeCd": null,
- "ValidInd": 1,
- "Translations": [
- {
- "LanguageCD": "FR",
- "Translation": "Aérien"
}
]
}
]
}
Retrieves the accounting agreements in place with partner operators in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AccountingAgreements": [
- {
- "OperatorCd": "string",
- "AccountingAgreementTypeCd": "LETR",
- "ValidYearFrom": 2020,
- "ValidYearTo": 2021,
- "CurrencyCd": "XDR",
- "RatesSdrInd": 1,
- "EMailAddress": "string",
- "PostalAddress": "string",
- "AccStageTypeCd": "1.1",
- "QosParticipation": 1,
- "QosCompulsory": 0.5,
- "QosBonus": 0.5,
- "WeightConfig": null,
- "BulkyIbrsStatus": 0,
- "PredesAutoValidation": 1,
- "IbrsReimsMethodB": 0,
- "BulkMailExcludedFromIacSent": 0,
- "BulkMailExcludedFromIacReceived": 0,
- "ExcludeURandUXMailFromSampling": 0,
- "DefaultCP94EcommerceRateStep": 0,
- "SlitContentFormatInbound": 0,
- "SplitContentFormatOutbound": 0,
- "PerformanceValueThreshold": 0.5,
- "PerformanceValuePenalty": 0.5,
- "DirectParcelsCurrencyCd": "XDR",
- "ReturnedParcelsCurrencyCd": "XDR",
- "TransitParcelsCurrencyCd": "XDR"
}
]
}
Retrieves the accounting stream types defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AccountingStreamTypes": [
- {
- "AccountingStreamTypeID": 11,
- "AccountingStreamTypeNm": "Letters: LCAO",
- "AccountingAgreementTypeCd": "LETR",
- "MailSubclassFCD": null,
- "ReceptacleSubTypeCd": null,
- "ReceptacleContentFormatCd": null,
- "MailItemCategoryCd": null,
- "MailCharacCd": null,
- "RateConfig": "0#0#1#1#1#",
- "ValidInd": 1
}
]
}
Retrieves the accounting peridos defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AccountingPeriods": [
- {
- "AccountingPeriodCd": "M",
- "AccountingPeriodNm": "Monthly",
- "Translations": [
- {
- "LanguageCD": "FR",
- "Translation": "Aérien"
}
]
}
]
}
Retrieves the accounting action types defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AccountingActionTypes": [
- {
- "AccountingActionTypeCd": "s",
- "AccountingActionTypNm": "Letters: quarter (CN55+CN56)",
- "validInd": 3,
- "MailFlow": "3",
- "MailCategoryCd": null,
- "PeriodCd": "Q",
- "AccountingTypeCd": "1",
- "MailClassCd": "U",
- "ProductTypeCd": null,
- "SupplementaryInd": "s",
- "Translations": [
- {
- "LanguageCD": "FR",
- "Translation": "Aérien"
}
], - "AccountingForms": [
- {
- "AccountingFormTypeCd": "CN55",
- "FormOrder": 2,
- "HasAdditionalCosts": null,
- "DoUpuClearing": null
}
]
}
]
}
Retrieves the accounting agreements in place with partner operators in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AccountingOperatorGroups": [
- {
- "AccountingOperatorGroupCd": "EU",
- "AccountingOperatorGroupNm": "European Union operators",
- "Operators": [
- {
- "OperatorCd": "FRA"
}
]
}
]
}
Retrieves the allowed partnerships for document capture defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "DocumentPartnerships": [
- {
- "MailCategoryCd": "A",
- "OriginOfficeFcd": "ITLINA",
- "DestOfficeFcd": "CAYTOA",
- "MailClassCd": "U",
- "MailSubclassCd": "UN",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "ScanRecInd": 1,
- "EtaHours": 0
}
]
}
Retrieves the verification note reasons defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "VnReasons": [
- {
- "VNReasonCd": "20",
- "VNReasonNm": "Good condition",
- "VNReasonCategoryCd": "1",
- "validInd": 1,
- "DisplayAsOtherIrregularityOnCN43": "0",
- "DisplayAsOtherIrregularityOnCP78": "0",
- "DisplayAsOtherIrregularityOnE2": "0",
- "Translations": [
- {
- "LanguageCD": "FR",
- "Translation": "Aérien"
}
]
}
]
}
Retrieves the verification note reason categories defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "VnReasonCategories": [
- {
- "VNReasonCategoryCd": "R",
- "VnReasonCategoryNm": "Receptacle irregularities",
- "Translations": [
- {
- "LanguageCD": "FR",
- "Translation": "Aérien"
}
]
}
]
}
Retrieves the terminal dues rates defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "TerminalDues": [
- {
- "AccountingStreamId": "11",
- "OperatorCd": "FRA",
- "PartnerOfficeFcd": "FRCGDA",
- "OwnOfficeFcd": "CAYTOA",
- "ConveyanceTypeCd": "N",
- "MailFlow": "I",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "ProductTypeCd": "P",
- "RateCriteriaCd": "string",
- "MultirateCriteriaPid": "string",
- "RateRevised": 0,
- "UserPid": 19,
- "MailCategoryCd": "A",
- "RateKg": 1.2345,
- "RateItem": 1.2345,
- "LastModifiedDt": "2022-09-16T14:26:30",
- "MailSubClassFcd": "UN",
- "History": [
- {
- "AccountingStreamId": "11",
- "OperatorCd": "FRA",
- "ConveyanceType": "P",
- "MailFlow": "I",
- "PartnerOfficeFcd": "FRCGDA",
- "OwnOfficeFcd": "CAYTOA",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "MailCategoryCd": "A",
- "RateKg": 1.2345,
- "RateItem": 1.2345,
- "LastModifiedDt": "2022-01-13T08:18:22",
- "Action": "Update",
- "ActionDate": "2022-09-16T14:26:30",
- "ProductTypeCd": "P",
- "RateCriteriaCd": "string",
- "MultirateCriteriaPid": "string",
- "RateRevised": 0,
- "MailSubClassFcd": "UN"
}
], - "IsDeleted": false
}
]
}
Retrieves the calculated IPKs defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "CalculatedIpks": [
- {
- "OperatorCd": "FRA",
- "MailFlow": "I",
- "Year": 2020,
- "Period": 2,
- "PeriodCd": "Q",
- "MailCategoryCd": "A",
- "MailSubclassFcd": "UN",
- "ReceptacleContentFormatCd": "P",
- "ProductTypeCd": null,
- "OwnOfficeFcd": "CAYTOA",
- "PartnerOfficeFcd": "FRCGDA",
- "ReceptacleSubTypeCd": "BG",
- "AdjustmentNetGross": 0.12345,
- "SampleNet": 123456789.123,
- "SampleGross": 123456789.123,
- "PProportion": 30,
- "GProportion": 30,
- "EProportion": 30,
- "Ipk": 12.223,
- "PIpk": 12.223,
- "GIpk": 12.223,
- "EIpk": 12.223,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Comments": "string",
- "LastModifiedDate": "2019-11-21T19:46:12.250",
- "History": [
- {
- "OperatorCd": "FRA",
- "MailFlow": "I",
- "Year": 2020,
- "Period": 2,
- "PeriodCd": "Q",
- "MailCategoryCd": "A",
- "MailSubclassFcd": "UN",
- "ReceptacleContentFormatCd": "P",
- "ProductTypeCd": null,
- "OwnOfficeFcd": "CAYTOA",
- "PartnerOfficeFcd": "FRCGDA",
- "ReceptacleSubTypeCd": "BG",
- "AdjustmentNetGross": 0.12345,
- "SampleNet": 123456789.123,
- "SampleGross": 123456789.123,
- "PProportion": 30,
- "GProportion": 30,
- "EProportion": 30,
- "Ipk": 12.223,
- "PIpk": 12.223,
- "GIpk": 12.223,
- "EIpk": 12.223,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Comments": "string",
- "LastModifiedDate": "2021-06-22T15:04:50.345",
- "Action": "Update",
- "ActionDate": "2022-09-16T14:26:30.678"
}
], - "IsDeleted": false
}
]
}
Retrieves the parcel bill rates defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "ParcelBillRates": [
- {
- "OperatorCd": "FRA",
- "CountryCd": "FR",
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Office": "FRCDGA",
- "MailFlow": "I",
- "Returned": 0,
- "RateParcel": 123.4567,
- "RateKg": 123.4567,
- "RateParcelBracket1": 123.4567,
- "RateKg Bracket1": 123.4567,
- "RateParcelBracket2": 123.4567,
- "RateKg Bracket2": 123.4567,
- "RateParcelBracket3": 123.4567,
- "RateKg Bracket3": 123.4567,
- "TransitParcel": 123.4567,
- "TransitKg": 123.4567,
- "Due1": 123.4567,
- "CustomsParcel": 123.4567,
- "Observations": "string",
- "IsDeleted": false,
- "History": [
- {
- "OperatorCd": "FRA",
- "CountryCd": "FR",
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Office": "FRCDGA",
- "MailFlow": "I",
- "Returned": 0,
- "RateParcel": 123.4567,
- "RateKg": 123.4567,
- "RateParcelBracket1": 123.4567,
- "RateKg Bracket1": 123.4567,
- "RateParcelBracket2": 123.4567,
- "RateKg Bracket2": 123.4567,
- "RateParcelBracket3": 123.4567,
- "RateKg Bracket3": 123.4567,
- "TransitParcel": 123.4567,
- "TransitKg": 123.4567,
- "Due1": 123.4567,
- "CustomsParcel": 123.4567,
- "Observations": "string",
- "LastModifiedDate": "2020-12-31T15:35:21:123",
- "Action": "Update",
- "ActionDate": "2020-12-31T15:35:21:123"
}
]
}
]
}
Retrieves the direct parcel rates defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "DirectParcelRates": [
- {
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "DestinationOperatorCd": "FRA",
- "DestinationCountryCd": "FR",
- "DestinationOfficeCd": "FRCDGA",
- "OriginOperatorCd": "NLA",
- "OriginOfficeCd": "NLAMSA",
- "CustomsRateParcel": 123.4567,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Observation": "string",
- "LastModifGmtDt": "2012-01-14T09:30:47.234",
- "ILRParcel": 123.4567,
- "ILRKg": 123.4567,
- "Step1Parcel": 123.4567,
- "Step1Kg": 123.4567,
- "Step2Parcel": 123.4567,
- "Step2Kg": 123.4567,
- "Step3Parcel": 123.4567,
- "Step3Kg": 123.4567,
- "UserPid": 19,
- "History": [
- {
- "Action": "Update",
- "HistValidFromGmtDt": "2012-01-14T09:30:47.234",
- "HistValidToGmtDt": "2012-12-14T21:30:47.234",
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "DestinationOperatorCd": "FRA",
- "DestinationCountryCd": "FR",
- "DestinationOfficeCd": "FRCDGA",
- "OriginOperatorCd": "NLA",
- "OriginOfficeCd": "NLAMSA",
- "CustomsRateParcel": 123.4567,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Observation": "string",
- "ILRParcel": 123.4567,
- "ILRKg": 123.4567,
- "Step1Parcel": 123.4567,
- "Step1Kg": 123.4567,
- "Step2Parcel": 123.4567,
- "Step2Kg": 123.4567,
- "Step3Parcel": 123.4567,
- "Step3Kg": 123.4567,
- "UserPid": 19
}
], - "IsDeleted": false
}
]
}
Retrieves the returned parcel rates defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "ReturnedParcelRates": [
- {
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "ReturningOperatorCd": "FRA",
- "ReturnToOperatorCd": "FRA",
- "UseILROfReturningOperator": true,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Observation": "string",
- "LastModifGmtDt": "2012-01-14T09:30:47.234",
- "ReturnedRateParcel": 123.4567,
- "ReturnedRateKg": 123.4567,
- "Step1Parcel": 123.4567,
- "Step1Kg": 123.4567,
- "Step2Parcel": 123.4567,
- "Step2Kg": 123.4567,
- "Step3Parcel": 123.4567,
- "Step3Kg": 123.4567,
- "AirConveyanceRate": 123.4567,
- "UserPid": 19,
- "History": [
- {
- "Action": "Update",
- "HistValidFromGmtDt": "2012-01-14T09:30:47.234",
- "HistValidToGmtDt": "2012-12-14T21:30:47.234",
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "ReturningOperatorCd": "FRA",
- "ReturnToOperatorCd": "FRA",
- "UseILROfReturningOperator": true,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Observation": "string",
- "ReturnedRateParcel": 123.4567,
- "ReturnedRateKg": 123.4567,
- "Step1Parcel": 123.4567,
- "Step1Kg": 123.4567,
- "Step2Parcel": 123.4567,
- "Step2Kg": 123.4567,
- "Step3Parcel": 123.4567,
- "Step3Kg": 123.4567,
- "AirConveyanceRate": 123.4567,
- "UserPid": 19
}
], - "IsDeleted": false
}
]
}
Retrieves the transit parcel rates defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "TransitParcelRates": [
- {
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "TransitOperatorCd": "FRA",
- "DestinationCountryCd": "FR",
- "DestinationOperatorCd": "FRA",
- "UseILROfDestination": true,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Observation": "string",
- "LastModifGmtDt": "2012-01-14T09:30:47.234",
- "TransitParcel": 123.4567,
- "TransitKg": 123.4567,
- "DestinationILRParcel": 123.4567,
- "DestinationILRKg": 123.4567,
- "Step1Parcel": 123.4567,
- "Step1Kg": 123.4567,
- "Step2Parcel": 123.4567,
- "Step2Kg": 123.4567,
- "Step3Parcel": 123.4567,
- "Step3Kg": 123.4567,
- "AirConveyanceRate": 123.4567,
- "Route": "string",
- "MaximumInsuredValue": 123456789112345.44,
- "NumberOfCustomsDeclarations": 1,
- "UserPid": 19,
- "History": [
- {
- "Action": "Update",
- "HistValidFromGmtDt": "2012-01-14T09:30:47.234",
- "HistValidToGmtDt": "2012-12-14T21:30:47.234",
- "MailCategoryCd": "A",
- "ProductTypeCd": "P",
- "TransitOperatorCd": "FRA",
- "DestinationCountryCd": "FR",
- "DestinationOperatorCd": "FRA",
- "UseILROfDestination": true,
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "Observation": "string",
- "TransitParcel": 123.4567,
- "TransitKg": 123.4567,
- "DestinationILRParcel": 123.4567,
- "DestinationILRKg": 123.4567,
- "Step1Parcel": 123.4567,
- "Step1Kg": 123.4567,
- "Step2Parcel": 123.4567,
- "Step2Kg": 123.4567,
- "Step3Parcel": 123.4567,
- "Step3Kg": 123.4567,
- "AirConveyanceRate": 123.4567,
- "Route": "string",
- "MaximumInsuredValue": 123456789112345.44,
- "NumberOfCustomsDeclarations": 1,
- "UserPid": 19
}
], - "IsDeleted": false
}
]
}
Retrieves the air conveyance charges defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "IacRates": [
- {
- "OperatorCd": "FRA",
- "OriginOfficeFcd": "FRCGDA",
- "DestinationOfficeFcd": "CAYTOA",
- "AccountingAgreementCd": "LETR",
- "ProductTypeCd": "P",
- "MailDirection": "I",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "RateKg": 123.4567,
- "IsDeleted": false,
- "History": [
- {
- "OperatorCd": "FRA",
- "OriginOfficeFcd": "FRCGDA",
- "DestinationOfficeFcd": "CAYTOA",
- "AccountingAgreementCd": "LETR",
- "ProductTypeCd": "P",
- "MailDirection": "I",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "RateKg": 123.4567,
- "Action": "Update",
- "ActionDate": "2020-12-31T15:35:21:123"
}
]
}
]
}
Retrieves the a decouvert groups and charges defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "AdecouvertRates": [
- {
- "TransitCountryCd": "FR",
- "MailCategoryCd": "A",
- "Groups": [
- {
- "GroupId": 1
}
], - "Countries": [
- {
- "CountryCD": "IT"
}
], - "Charges": [
- {
- "GroupNm": "FR_G1",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "RateKg": 123.4567
}
], - "History": [
- {
- "GroupNm": "FR_G1",
- "ValidFrom": "2020-01-01",
- "ValidTo": "2020-12-31",
- "RateKg": 123.4567,
- "Action": "Update",
- "ActionDate": "2020-12-31T15:35:21:123"
}
], - "IsDeleted": false
}
]
}
Retrieves the closed transit charges defined in IPS.
Access to this method is authorized by the Get Accounting Rates operation.
Success
Bad Request
Unauthorized
Internal Server Error
{- "ClosedTransitCharges": [
- {
- "TransitCountryCd": "FR",
- "DestCountryCd": "IT",
- "MailClassCd": "U",
- "AccTypeCd": "string",
- "OfficeFcd": "FRCGDA",
- "ValidFrom": "2020-01-01",
- "RateKg": 123.4567,
- "RateItem": 123.4567,
- "LastModifDate": "2020-12-31T15:35:21:123",
- "ProductCd": "P",
- "TransitLocationFcd": "FRCDG",
- "DestLocationFcd": "ITLIN",
- "OriginOperatorCd": "CA",
- "CurrencyCd": "XDR",
- "IsDeleted": false,
- "History": [
- {
- "TransitCountryCd": "FR",
- "DestCountryCd": "IT",
- "MailClassCd": "U",
- "AccTypeCd": "string",
- "OfficeFcd": "FRCGDA",
- "ValidFrom": "2020-01-01",
- "RateKg": 123.4567,
- "RateItem": 123.4567,
- "LastModifDate": "2020-12-31T15:35:21:123",
- "ProductCd": "P",
- "TransitLocationFcd": "FRCDG",
- "DestLocationFcd": "ITLIN",
- "OriginOperatorCd": "CA",
- "CurrencyCd": "XDR",
- "Action": "Update",
- "ActionDate": "2020-12-31T15:35:21:123"
}
]
}
]
}