Accounting rates service

Retrieves accounting rates

Accounting agreement types

Retrieves the accounting agreement types defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/accountingagreementtypes
Response samples
application/json
{
  • "AccountingAgreementTypes": [
    ]
}

Accounting agreements

Retrieves the accounting agreements in place with partner operators in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/accountingagreements
Response samples
application/json
{
  • "AccountingAgreements": [
    ]
}

Accounting stream types

Retrieves the accounting stream types defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/accountingstreamtypes
Response samples
application/json
{
  • "AccountingStreamTypes": [
    ]
}

Accounting periods

Retrieves the accounting peridos defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/accountingperiods
Response samples
application/json
{
  • "AccountingPeriods": [
    ]
}

Accounting action types

Retrieves the accounting action types defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/accountingactiontypes
Response samples
application/json
{
  • "AccountingActionTypes": [
    ]
}

Accounting operator groups

Retrieves the accounting agreements in place with partner operators in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/accountingoperatorgroups
Response samples
application/json
{
  • "AccountingOperatorGroups": [
    ]
}

Allowed partnerships for document capture

Retrieves the allowed partnerships for document capture defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/documentpartnerships
Response samples
application/json
{
  • "DocumentPartnerships": [
    ]
}

Verification note reasons

Retrieves the verification note reasons defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/vnreasons
Response samples
application/json
{
  • "VnReasons": [
    ]
}

Verification note reason categories

Retrieves the verification note reason categories defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/vnreasoncategories
Response samples
application/json
{
  • "VnReasonCategories": [
    ]
}

Terminal dues rates

Retrieves the terminal dues rates defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted terminal dues

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/terminaldues
Response samples
application/json
{
  • "TerminalDues": [
    ]
}

Calculated IPKs

Retrieves the calculated IPKs defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted calculate IPKs

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/calculatedipks
Response samples
application/json
{
  • "CalculatedIpks": [
    ]
}

Parcel bill rates

Retrieves the parcel bill rates defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted parcel bill rates

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/parcelbillrates
Response samples
application/json
{
  • "ParcelBillRates": [
    ]
}

Direct parcel rates

Retrieves the direct parcel rates defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted direct parcel rates

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/directparcelrates
Response samples
application/json
{
  • "DirectParcelRates": [
    ]
}

Returned parcel rates

Retrieves the returned parcel rates defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted returned parcel rates

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/returnedparcelrates
Response samples
application/json
{
  • "ReturnedParcelRates": [
    ]
}

Transit parcel rates

Retrieves the transit parcel rates defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted transit parcel rates

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/transitparcelrates
Response samples
application/json
{
  • "TransitParcelRates": [
    ]
}

Air conveyance charges

Retrieves the air conveyance charges defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted IAC rates

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/iacrates
Response samples
application/json
{
  • "IacRates": [
    ]
}

A decouvert groups and charges

Retrieves the a decouvert groups and charges defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted a decouvert rates

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/adecouvertrates
Response samples
application/json
{
  • "AdecouvertRates": [
    ]
}

Closed transit charges

Retrieves the closed transit charges defined in IPS.

Access to this method is authorized by the Get Accounting Rates operation.

Securityips_token
Request
query Parameters
validOn
string <date>

Retrieves only rates valid on the specified date

includeDeleted
boolean

Includes deleted transit charges

Example: includeDeleted=true
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/accountingratesService.svc/rest/closedtransitcharges
Response samples
application/json
{
  • "ClosedTransitCharges": [
    ]
}