Create Purchase Order

POST /api/.../purchaseorders

Create purchase order.

Request Information

Parameters
Name Type Required Description
dtoPurchaseOrderCreateInfo Purchase Order Yes Define this parameter in the request body.
DtoPurchaseOrderCreateInfo
Property Type Nullable Description
AutoCancelInd Boolean Yes Default flag to determine if lines should be included in overnight cancellation processing
BackorderInstrID Int Yes Integer value for linked backorder instructions.
BindingSubInstrID Int Yes ID number for linked binding substitution instructions to supplier.
CatServInstrID Int Yes ID number for linked cataloging services instructions to supplier.
CatServChargeBase Decimal Yes Cataloging service charge in the base currency of the library.
ClmWtPer1 Short Yes The number of days to wait after a purchase order is released before the first claim.
ClmWtPer2 Short Yes Number of days to wait after first claim before sending a second.
ClmWtPer3 Short Yes Number of days to wait after second claim before sending a third.
ClmWtPer4 Short Yes Number of days to wait after third claim before sending a fourth.
ClmWtPer5 Short Yes Number of days to wait after fourth claim before sending a fifth.
ClmNoticeInd Boolean Yes Default flag to determine if lines should have claim notices generated in overnight claim processing.
CanNoticeInd Boolean Yes Default flag to determine if lines should have cancellation notices generated in overnight cancellation processing.
CanWtPer Int Yes Default number of days after last claim is generated that the lines should be automatically cancelled during overnight processing.
DelBillInstr Short Yes Reflects a delayed billing arrangement between the library or branch and the supplier, or other special billing terms (represents the month which billing for an item(s) should begin).
DiscRate Decimal Yes Discount rate applied to the line item.
ExternalID String Yes Used to hold the PO# from an external accounting system.
EDIFileCreateDateTime DateTime Yes System generated date & time that a BISAC file for this order was created.
EDIFileName String Yes Name of the BISAC file created for this order.
InvDeliveryMethID Int Yes ID number for linked invoice delivery method instructions to supplier.
InvSequencingID Int Yes ID number for linked invoice sequencing instructions to supplier.
InstrSupp String Yes Free text field for instructions to supplier/vendor.
InvCopies Int Yes Number of copies of invoice the supplier should send.
IsTemplate Boolean No This element determines whether or not the PO is a template or an actual PO.
MaxClaims Short Yes The number of claims that will be made against an item before it is canceled, or other action taken.
MembershipRenewalDate DateTime Yes The date on which a membership is due for renewal.
OrderCancelInstr DateTime Yes Instructions to the supplier about the date that an order should be canceled, if the item is not currently available. Its format is date or period of time
OtherChargeBase Decimal Yes Other charges associated with the order in the base currency of the library.
OrderTypeID Int Yes ID number for linked purchase order type.
OrganizationID Int Yes ID number of organization that created/placed the order.
PaymentMethodID Int Yes ID number for linked payment method.
PlanName String Yes Name of the plan associated with the purchase order.
PONote String Yes Free text field for notes related to the purchase order.
POAddChrgsSubtotBase Decimal Yes Subtotal of additional charges associated with the order in the base currency of the library.
POAuthorization String Yes Name of person authorized to allow purchase orders to be released.
POConfirmDate DateTime Yes The date upon which the library received confirmation from a supplier/vendor that the order had been received.
POGrndTotBase Decimal Yes Purchase Order grand total in library's base currency.
POMaterSubtotBase Decimal Yes Accumulated "Total Discount Price" for all lines on the purchase order in the library's base currency.
PONumber String Yes Library or system assigned purchase order number.
PONumberSuf String Yes Suffix to a purchase order number.
ReleaseDate DateTime Yes Date that purchase order was released on.
RentalReturnDate DateTime Yes Return date for any rented materials.
Resale Boolean No Flag stating whether or not items on the purchase order are for resale.(0=NO(default)/1=YES).
SalesTax1Base Decimal Yes Main sales tax associated with this order in the base currency of the library.
SalesTaxRate1 Decimal Yes The standard sales tax rate associated with purchasing items from a particular supplier.
ServChargeBase Decimal Yes Service charge associated with the order in the base currency of the library.
ShipChargeBase Decimal Yes Shipping charge associated with the order in the base currency of the library.
ShipDate DateTime Yes Instructions to the supplier about the earliest date an order is to be shipped.
SupplierID Int No ID number of supplier to which the order was sent.
ShippingMethodID Int Yes ID number for linked shipping method instructions to supplier.
SpecialHandChargeBase Decimal Yes Special handling charge associated with the order in the base currency of the library.
TemplateName String Yes A user-assigned name that uniquely identifies a purchase order template
Example
application/json, text/json 
 {
  {
    "AutoCancelInd": false,
    "BackorderInstrID": null,
    "BindingSubInstrID": null,
    "CatServInstrID": null,
    "CatServChargeBase": null,
    "ClmWtPer1": null,
    "ClmWtPer2": null,
    "ClmWtPer3": null,
    "ClmWtPer4": null,
    "ClmWtPer5": null,
    "ClmNoticeInd": false,
    "CanNoticeInd": false,
    "CanWtPer":null,
    "DelBillInstr": null,
    "DiscRate": 40,
    "ExternalID": null,
    "EDIFileCreateDateTime": null,
    "EDIFileName": null,
    "InvDeliveryMethID": null,
    "InvSequencingID": null,
    "InstrSupp": null,
    "InvCopies": 1,
    "IsTemplate": false,
    "MaxClaims": 0,
    "MembershipRenewalDate": null,
    "OrderCancelInstr": null,
    "OtherChargeBase": null,
    "OrderTypeID": 3,
    "OrganizationID": 101,
    "PaymentMethodID": null,
    "PlanName": null,
    "PONote": null,
    "POAddChrgsSubtotBase": 0,
    "POAuthorization": null,
    "POConfirmDate":null,
    "POGrndTotBase": 8.0,
    "POMaterSubtotBase": 9.0,
    "PONumber": "AMD666",
    "PONumberSuf": "ami",
    "ReleaseDate": null,
    "RentalReturnDate": null,
    "Resale": false,
    "SalesTax1Base": 0.1,
    "SalesTax2Base": 0,
    "SalesTaxRate1": 10,
    "SupplierID": 84,
    "ServChargeBase": 0,
    "ShipChargeBase": 0,
    "ShipDate": null,
    "SpecialHandChargeBase": 0,
    "ShippingMethodID": null,
    "TemplateName": null
  }

Response Information

Example for purchase order create returns new PurchaseOrderID
application/json, text/json 
    {
        16153
    }

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid data

Required Permissions

Permission IDs found here.

    CR_AccessAcquisitions_Allow
    CR_PurchaseOrders_Create