Open Invoices Web Service

A. Duie Pyle provides information on all open invoices for each account linked to your MyPyle login via a web service that returns either a JSON object or an XML document. A summarized or detailed version can be provided by adjusting the 'detailed' boolean parameter in the URL.

Your MyPyle login must be authorized to access this web service. Please complete the Open Invoices Web Service Setup Request form to request this authorization.

Summarized Invoices

This returns a summarized version of each invoice. Requesting summarized invoices is faster and returns smaller results.

A longer than normal timeout of 15 minutes may be required.

Example cURL Request

GET

/1/billing/invoices

curl -G https://api.aduiepyle.com/1/billing/invoices \
  -H "Content-Type:application/json" \
  -d user="MyPyleID" \
  -d accountCode="account" \
  -d detailed=0

Detailed Invoices

This returns a detailed version of each invoice. This includes the billing lines in each invoice. Requesting detailed invoices is slower and returns larger results.

A longer than normal timeout of 15 minutes may be required.

Example cURL Request

GET

/1/billing/invoices

curl -G https://api.aduiepyle.com/1/billing/invoices \
  -H "Content-Type:application/json" \
  -d user="MyPyleID" \
  -d accountCode="account" \
  -d detailed=1

Request Parameters

Name
user
Description
The MyPyle login email address.
Name
accountCode
Description
The account code. The account code always starts with a P1 and is eight characters long.
Name
detailed
Description
For summarized invoices, set this to 0. For detailed invoices, set this to 1.

Examples

The following example will request a transit time XML document from Exton, PA (19341) to Montpelier, VT (05602).

Example cURL Request

GET

/1/billing/invoices

curl -G https://api.aduiepyle.com/1/billing/invoices \
  -H "Content-Type:application/json" \
  -d user="duie@pyleco.com" \
  -d accountCode="P1ADWE65" \
  -d detailed=1

Example Response

{
  "result": {
    "accountCode": "PABA1A",
    "invoices": {
      "invoice": [
        {
          "pro": "671831022",
          "statementNumber": "12348765",
          "invoiceDate": "2022-05-02",
          "billOfLadingNumber": {
            "data": ["NS"]
          },
          "purchaseOrder": {
            "data": ["000004305"]
          },
          "amountDue": 564.2,
          "totalCharge": 564.2,
          "weight": 4950,
          "pieces": 9,
          "paymentMethod": "PREPAID",
          "entities": {
            "entity": [
              {
                "type": "consignee",
                "code": "DACE1C",
                "name": "DAVIDS COOKIES",
                "address1": "11 CLIFFSIDE DR",
                "address2": "",
                "city": "CEDAR GROVE",
                "state": "NJ",
                "zip": "07009"
              },
              {
                "type": "shipper",
                "code": "PABA1A",
                "name": "PARKER FLAVORS INC",
                "address1": "1801 A PORTAL ST",
                "address2": "",
                "city": "BALTIMORE",
                "state": "MD",
                "zip": "21224"
              },
              {
                "type": "bill_to",
                "code": "PABA1A",
                "name": "PARKER FLAVORS INC",
                "address1": "1801 A PORTAL ST",
                "address2": "",
                "city": "BALTIMORE",
                "state": "MD",
                "zip": "21224"
              }
            ]
          },
          "pickup": {
            "arrival": "2022-04-29T15:29",
            "trailer": "6404R",
            "truck": "1036"
          },
          "delivery": {
            "arrival": "2022-05-02T10:44",
            "trailer": "4283H",
            "truck": "10155"
          },
          "details": {
            "detail": [
              {
                "description": "46.9% FUEL SURCHARGE",
                "pieces": 0,
                "weight": 0,
                "container": "",
                "class": 0,
                "rate": 0.469,
                "rateQualifier": "CT",
                "specialChargeCode": "FUE",
                "charge": 119.03
              }
            ]
          }
        }
      ]
    }
  }
}

Response Properties

Name
accountCode
Description
the company’s account code
Name
invoice
Description
list of invoice details
Name
pro
Description
pro number of the invoice
Name
statementNumber
Description
statement number
Name
invoiceDate
Description
invoice date
Name
billOfLadingNumber
Description
contains list of BOL numbers
Name
purchaseOrder
Description
contains list of purchase order numbers
Name
amountDue
Description
amount due
Name
totalCharge
Description
total amount charge
Name
weight
Description
weight of pro
Name
pieces
Description
pieces of pro
Name
paymentMethod
Description
payment method for this transaction
Name
entity
Description
list of the pro shipper, consignee, and bill to details
Name
type
Description
type of account which is either shipper, consignee or bill to
Name
code
Description
account code
Name
name
Description
account name
Name
address1
Description
account address 1
Name
address2
Description
account address 2
Name
city
Description
account city
Name
state
Description
account state
Name
zip
Description
account zip code
Name
pickup
Description
pickup details
Name
arrival
Description
pickup arrival date time
Name
trailer
Description
pickup trailer unit code
Name
truck
Description
pickup truck unit code
Name
delivery
Description
delivery details
Name
arrival
Description
delivery arrival date time
Name
trailer
Description
delivery trailer unit code
Name
truck
Description
delivery truck unit code

For a detailed result

Name
details
Description
list of billing lines
Name
description
Description
description of the item
Name
pieces
Description
pieces
Name
weight
Description
weight
Name
container
Description
type of container
Name
class
Description
commodity class
Name
rate
Description
rate code
Name
rateQualifier
Description
rate qualifier
Name
specialChargeCode
Description
special charge code
Name
charge
Description
amount charge

Detailed Invoice Codes

Rate Qualifier Codes

Code	Description
FR	Flat Rate
MN	Minimum
PF	Per Cubic Foot
PG	Per Gallon
PH	Per Hundred(of Basic Unit)
PL	Per Load
PM	Per Mile
PP	Per Piece
PS	Per Shipment
PU	Per Unit
SY	Square Yard

Special Codes

Code	Description
020	Address Correction
045	Advance Fee
105	Acknowledgement of Delivery Fee (AOD)
140	Call Tag
275	Discount – Incentive
300	Distribution Fee
405	Fuel Surcharge
455	Insurance Premium
520	Oversized Premium
675	Security Signature Service
705	Stamp Fee
735	Tracing Inbound Via Other Carriers
ADH	Advance Charges Handling
AFB	Additional Copies of Freight Bill
APT	Appointment (Notification)
ARB	Arbitrary (In Addition to Through Rates and Charges)
BEY	Beyond Freight Charges
BLK	Blocking and Bracing Charge
BND	Bond Charges
CLN	Cleaning Charge
CNS	Consolidation
COD	COD Amount
COL	Fee for Collecting COD Charge
COM	Combination
DEL	Delivery Charge
DER	Derrick Charge
DET	Detention of Trailers
DIS	Distribution Service
DIV	Diversion and Reconsignment
DMC	Deadhead Mileage Charge
DSC	Discount
DTL	Detention Loading
DTU	Detention Unloading
DTV	Detention (Vehicle)
EIC	Export/Import Charge
ELS	Extra Lights
EMT	Empty Movement
ENS	Energy Surcharge (Fuel Adjustment Factor)
ERS	Empty Return
EVC	Excessive Value Charge
EXC	Exclusive Use Charge
EXM	Excess Mileage Charge
EXW	Excess Weight
FUE	Fuel Charge
GST	Goods and Services Tax Charge
HAN	Handling Charges on Distribution Freight Forwarded Beyond
HOL	Sunday or Holiday Pick-up or Delivery
HOS	Hose Charge
IDL	Inside Delivery
IPU	Inside Pick-up
LAB	Extra Labor (Helper Service)
LAY	Layover Charges
LFT	Lift Gate (Truck) or Forklift Service at Pick-up/Delivery
LOA	Loading (Labor Charges)
MEN	Escort Service with Overnight Subsistence
MET	Escort Service (Telephone)
MIN	Minimum Guarantee
MNC	Notify Consignee
MRK	Marking or Tagging Charge
MSC	Other Accessorial Service Charge
MSG	Miscellaneous Charge
OVR	Over Dimension
PBE	Permits Bonds Escort Attendant
PEC	Pallet Exchange Charge
PER	Permit Charge
PIR	Pier Pick-up and/or Delivery
PMU	Normal Pump Charge
POD	Proof of Delivery
PCS	Protective Service – Cold
PSG	Protective Service Security with Armed Guards
PUC	Pick-up Charge
PUD	Pick-up and Delivery
RCC	Reconsignment Charge
RCL	Redelivery
REP	Residential Pick-up
RES	Residential Delivery
SCL	Scale Charge
SDL	Split Delivery
SEG	Segregating (Sorting)
SER	Service Charge
SOC	Stop-off Charge
SPC	Special Permits
SPT	Spotting of Trailer
SPU	Split Pick-up
SRG	Storage
SSC	Stripping, Sorting, and Consolidation
SSF	Single Shipment Fee
STR	Storage in Transit
SUF	Sufferance Warehouse Charge (Export or Import)
SUR	Surcharge
TAX	Tax Charge
TRA	Travel Charge
TRC	Trailer Rental Charge
UND	Unloading
UNL	Unloading (Labor Charges)
URC	Unloading/Reloading Charge
VOR	Vehicle Ordered but Not Used
WRC	Load Weighing Charge
WTV	Weight Verification Charge

If you are not obtaining the invoices that you're expecting it's probably because the account isn't linked to your MyPyle login. Please contact us at 800−523−5020 x34236 or email the AFM Department.

Please note that EDI Services and Web Services are not available between 12 Midnight and 12:15 AM Eastern Time during our server maintenance window.

All customers using the Web Services should sign up for Web Services Notification to be informed whenever one of the Web Service interfaces is updated.

Revision 2 – 04/14/2023