Create invoice line item.

PUT /api/.../invoices/{id:int}/invlineitems?source={source:string}&allowDuplicates=false&ignoreDisplayInPACWarning=false

Create one invoice line item and a bibliographic record.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the invoice.
DtoInvoiceLineItemCreateBriefBib Invoice Line Item create Information Yes Define this parameter in the request body when source=createbib.
DtoInvoiceLineItemCreateWithExistingBib Invoice Line Item and Segments Information Yes Define this parameter in the request body when source=existingbib.
source string One of the following: 'createbib' or 'existingbib' Discriminator for request content type.
allowDuplicates bool Yes Indicator to allow saving duplicate segments. Default is false if not specified.
ignoreDisplayInPACWarning bool No >Indicator to ignore Display in PAC warning. Default is false if not specified.
Example (source=createbib, body=DtoInvoiceLineItemCreateBriefBib)
application/json, text/json 
         {
             "Alert": false,
             "Author": "S. Smith",
             "BriefBibCreationData": {
                  "TemplateID": 0,
                  "ISBN_ISSN": "1580111491",
                  "Title": "The beach",
                  "Author": "S. Smith",
                  "Publisher": "publisher",
                  "PublicationYear": "9875",
                  "Edition": "23",
                  "DisplayInPAC": true,
                  "CatalogNumber": "123456",
                  "LCCN": "112233333",
                  "ListPriceUnitBase": 8.95
             },
             "CatalogNumber": null,
             "DiscPriceUnitBase": 8.95,
             "ISBN_ISSN": "1580111491",
             "ListPriceUnitBase": 8.95,
             "MaterialTypeID": 1,
             "Notes": null,
             "Segments": [
                 {  
                     "BindFormatChargeBase": 0,
                     "CatServChargeBase": .75,
                     "DestinationCollectionID": 4,
                     "DestinationOrgID": 23,
                     "InvLineItemSegmentID": 0,
                     "Funds": [
                     ],
                     "OtherChargeBase": 0,
                     "ServChargeBase": 0,
                     "ShipChargeBase": 0,
                     "SpecialHandChargeBase": 0,
                     "Quantity": 1,
                     "InvLISegmentNumber": 1
                 }
             ],
             "ShippedDate": null, 
             "Title": 'The beach,
             "BibliographicRecordID": 520724
         }
Example (source=existingbib, body=DtoInvoiceLineItemCreateWithExistingBib)
application/json, text/json 
 {
    "Alert": false,
    "Author": null,
    "CatalogNumber": null,
    "DiscPriceUnitBase": 5.15,
    "ISBN_ISSN": "1580111491 (pbk.) :",
    "ListPriceUnitBase": 8.95,
    "MaterialTypeID": 1,
    "Notes": null,
    "Segments": [
        {  
            "BindFormatChargeBase": 0,
            "CatServChargeBase": .75,
            "DestinationCollectionID": 4,
            "DestinationOrgID": 23,
            "InvLineItemSegmentID": 0,
            "Funds": [],
            "OtherChargeBase": 0,
            "ServChargeBase": 0,
            "ShipChargeBase": 0,
            "SpecialHandChargeBase": 0,
            "Quantity": 1,
            "InvLISegmentNumber": 1
        }
    ],
    "ShippedDate": null, 
    "Title": null,
    "BibliographicRecordID": 520724
}

Response Information

Returns the id of the new Invoice Line item

Property Type Description
ID Integer Invoice line item identifier.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
404 FAILURE.
  • Invoice line item not found

Required Permissions

Permission IDs found here.

    CR_AccessAcquisitions_Allow (),
    CR_Invoices_Access (based on owner ID),
    CR_Invoices_Modify (based on owner ID)
    CR_Invoices_Create (based on owner ID)
    CR_BibliographicRecords_Access 
    CR_CreateABibRecordFromAcquisitionsAndSerials_Allow