PUT Api/Invoice
Insert or update invoices into the system.
Request Information
URI Parameters
None.
Body Parameters
APIInvoiceRequestModelName | Description | Type | Additional information |
---|---|---|---|
Invoices |
List of invoices to Add/Update. |
Collection of InvoiceModel |
None. |
SendNewBillNotificationEmail |
Flag to send a "New Bill Available" e-mail for inserted invoices. Defaults to false. |
boolean? |
None. |
Request Formats
application/json, text/json
{ "Invoices": [ { "Address": "sample string 3", "Address2": "sample string 4", "AmountDue": 1.0, "BillerInvoiceNo": "sample string 5", "BillerRemittanceField1": "sample string 6", "BillerRemittanceField2": "sample string 7", "BillerRemittanceField3": "sample string 8", "BillerRemittanceField4": "sample string 9", "BillerRemittanceField5": "sample string 10", "City": "sample string 11", "CompanyName": "sample string 12", "Country": "sample string 13", "CurrentCharges": 1.0, "CustomAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Details": [ { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" }, { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" } ], "DisplayField1": "sample string 14", "DisplayField2": "sample string 15", "DisplayField3": "sample string 16", "DisplayField4": "sample string 17", "DisplayField5": "sample string 18", "DueDate": "2025-05-21T06:35:30.1559798Z", "EIR": true, "Email": "test1@test.com", "EntryField1": "sample string 20", "EntryField2": "sample string 21", "EntryField3": "sample string 22", "EntryField4": "sample string 23", "EntryField5": "sample string 24", "ExternalID": "sample string 26", "Fax": "sample string 28", "FDICode": "sample string 29", "FirstName": "sample string 30", "ID": 31, "InvoiceAge": 32, "InvAltTaxAmount": 1.0, "InvAltTaxAmtItmLevel": 1.0, "InvAltTaxIdItmLevel": "sample string 33", "InvAltTaxIDOrdLevel": "sample string 34", "InvAltTaxID": "sample string 35", "InvAltTaxRate": "sample string 36", "InvAltTaxType": "sample string 37", "InvAltTaxTypeApp": "sample string 38", "InvCommodityCode": "sample string 39", "InvCustomerCode": "sample string 40", "InvDestAddress1": "sample string 41", "InvDestAddress2": "sample string 42", "InvDestCardholderName": "sample string 43", "InvDestCity": "sample string 44", "InvDestCountryCode": "sample string 45", "InvDestStateCode": "sample string 46", "InvDestZipCode": "sample string 47", "InvDiscountPerItem": 1.0, "InvDutyAmount": 1.0, "InvFreightAmount": 1.0, "InvLineItemTotal": 1.0, "InvLineItemDiscountRate": "sample string 48", "InvLineItemTaxRate": "sample string 49", "InvLineItemVATTaxAmount": 1.0, "InvLineItemVATTaxRate": "sample string 50", "InvLocalTaxAmount": 1.0, "InvLocalTaxItmLevel": 1.0, "InvLocalTaxRate": "sample string 51", "InvMerchantVATRegistrationNumber": "sample string 52", "InvNationalTaxAmount": 1.0, "InvNationalTaxItmLevel": 1.0, "InvNationalTaxRate": "sample string 53", "InvNetGrossIndicator": "sample string 54", "InvOrderDisAmtOrdLevel": "sample string 55", "InvProductCode": "sample string 56", "InvProductName": "sample string 57", "InvProductSKU": "sample string 58", "InvPurchaseID": "sample string 59", "InvPurchaseIDItmLevel": "sample string 60", "InvPstTaxRegNum": "sample string 61", "InvRequestorName": "sample string 62", "InvQuantity": 1, "InvShipFromZipCode": "sample string 63", "InvSummaryCommodityCode": "sample string 64", "InvSupplierOrdRef": "sample string 65", "InvTaxAmount": 1.0, "InvTaxRate": "sample string 66", "InvUnitCost": 1.0, "InvUnitMeasure": "sample string 67", "InvVatRefNumber": "sample string 68", "InvVatRegNumber": "sample string 69", "InvVatTaxAmount": 1.0, "InvVatTaxRate": "sample string 70", "LastName": "sample string 74", "MerchantDescriptor": "sample string 75", "MerchantDescriptorAlt": "sample string 76", "MerchantDescriptorCity": "sample string 77", "MerchantDescriptorContact": "sample string 78", "MerchantDescriptorCountry": "sample string 79", "MerchantDescriptorState": "sample string 80", "MerchantDescriptorStreet": "sample string 81", "MerchantDescriptorZip": "sample string 82", "Message_OutstandingBalance": "sample string 83", "MiddleName": "sample string 84", "MinimumAmountDue": 1.0, "OtherData": "sample string 85", "PaymentInstrumentBlock": "sample string 86", "PaymentReceived": 1.0, "PaymentsPostedAsOfDate": "2025-05-21T06:35:30.1715938Z", "PayThisAmount": 1.0, "Phone": "sample string 87", "Prev_0To30Days": 1.0, "Prev_30To60Days": 1.0, "Prev_60To90Days": 1.0, "Prev_90DaysPlus": 1.0, "PreviousBalance": 1.0, "ReferenceNumber": "sample string 88", "State": "sample string 89", "StatementDate": "2025-05-21T06:35:30.1715938Z", "Status": "Active", "TotalAccountBalance": 1.0, "WaiveFee": true, "Zip": "sample string 90" }, { "Address": "sample string 3", "Address2": "sample string 4", "AmountDue": 1.0, "BillerInvoiceNo": "sample string 5", "BillerRemittanceField1": "sample string 6", "BillerRemittanceField2": "sample string 7", "BillerRemittanceField3": "sample string 8", "BillerRemittanceField4": "sample string 9", "BillerRemittanceField5": "sample string 10", "City": "sample string 11", "CompanyName": "sample string 12", "Country": "sample string 13", "CurrentCharges": 1.0, "CustomAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Details": [ { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" }, { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" } ], "DisplayField1": "sample string 14", "DisplayField2": "sample string 15", "DisplayField3": "sample string 16", "DisplayField4": "sample string 17", "DisplayField5": "sample string 18", "DueDate": "2025-05-21T06:35:30.1559798Z", "EIR": true, "Email": "test1@test.com", "EntryField1": "sample string 20", "EntryField2": "sample string 21", "EntryField3": "sample string 22", "EntryField4": "sample string 23", "EntryField5": "sample string 24", "ExternalID": "sample string 26", "Fax": "sample string 28", "FDICode": "sample string 29", "FirstName": "sample string 30", "ID": 31, "InvoiceAge": 32, "InvAltTaxAmount": 1.0, "InvAltTaxAmtItmLevel": 1.0, "InvAltTaxIdItmLevel": "sample string 33", "InvAltTaxIDOrdLevel": "sample string 34", "InvAltTaxID": "sample string 35", "InvAltTaxRate": "sample string 36", "InvAltTaxType": "sample string 37", "InvAltTaxTypeApp": "sample string 38", "InvCommodityCode": "sample string 39", "InvCustomerCode": "sample string 40", "InvDestAddress1": "sample string 41", "InvDestAddress2": "sample string 42", "InvDestCardholderName": "sample string 43", "InvDestCity": "sample string 44", "InvDestCountryCode": "sample string 45", "InvDestStateCode": "sample string 46", "InvDestZipCode": "sample string 47", "InvDiscountPerItem": 1.0, "InvDutyAmount": 1.0, "InvFreightAmount": 1.0, "InvLineItemTotal": 1.0, "InvLineItemDiscountRate": "sample string 48", "InvLineItemTaxRate": "sample string 49", "InvLineItemVATTaxAmount": 1.0, "InvLineItemVATTaxRate": "sample string 50", "InvLocalTaxAmount": 1.0, "InvLocalTaxItmLevel": 1.0, "InvLocalTaxRate": "sample string 51", "InvMerchantVATRegistrationNumber": "sample string 52", "InvNationalTaxAmount": 1.0, "InvNationalTaxItmLevel": 1.0, "InvNationalTaxRate": "sample string 53", "InvNetGrossIndicator": "sample string 54", "InvOrderDisAmtOrdLevel": "sample string 55", "InvProductCode": "sample string 56", "InvProductName": "sample string 57", "InvProductSKU": "sample string 58", "InvPurchaseID": "sample string 59", "InvPurchaseIDItmLevel": "sample string 60", "InvPstTaxRegNum": "sample string 61", "InvRequestorName": "sample string 62", "InvQuantity": 1, "InvShipFromZipCode": "sample string 63", "InvSummaryCommodityCode": "sample string 64", "InvSupplierOrdRef": "sample string 65", "InvTaxAmount": 1.0, "InvTaxRate": "sample string 66", "InvUnitCost": 1.0, "InvUnitMeasure": "sample string 67", "InvVatRefNumber": "sample string 68", "InvVatRegNumber": "sample string 69", "InvVatTaxAmount": 1.0, "InvVatTaxRate": "sample string 70", "LastName": "sample string 74", "MerchantDescriptor": "sample string 75", "MerchantDescriptorAlt": "sample string 76", "MerchantDescriptorCity": "sample string 77", "MerchantDescriptorContact": "sample string 78", "MerchantDescriptorCountry": "sample string 79", "MerchantDescriptorState": "sample string 80", "MerchantDescriptorStreet": "sample string 81", "MerchantDescriptorZip": "sample string 82", "Message_OutstandingBalance": "sample string 83", "MiddleName": "sample string 84", "MinimumAmountDue": 1.0, "OtherData": "sample string 85", "PaymentInstrumentBlock": "sample string 86", "PaymentReceived": 1.0, "PaymentsPostedAsOfDate": "2025-05-21T06:35:30.1715938Z", "PayThisAmount": 1.0, "Phone": "sample string 87", "Prev_0To30Days": 1.0, "Prev_30To60Days": 1.0, "Prev_60To90Days": 1.0, "Prev_90DaysPlus": 1.0, "PreviousBalance": 1.0, "ReferenceNumber": "sample string 88", "State": "sample string 89", "StatementDate": "2025-05-21T06:35:30.1715938Z", "Status": "Active", "TotalAccountBalance": 1.0, "WaiveFee": true, "Zip": "sample string 90" } ], "SendNewBillNotificationEmail": true }
Response Information
Resource Description
Insert or update invoices into the system.
InvoicesUpdateModelName | Description | Type | Additional information |
---|---|---|---|
ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
ErrorMessages |
List of errors that occurred when adding/updating the invoices. |
Collection of string |
None. |
ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
Errors |
Number of errors encountered when doing the invoice update. |
int |
None. |
Inserted |
Number of invoices that were inserted. |
int |
None. |
InvoiceCount |
Number of invoices that were processed. |
int |
None. |
Invoices |
List of the invoices that were inserted or updated. |
Collection of InvoiceModel |
None. |
Rejected |
Number of invoices that were rejected. |
int |
None. |
Success |
Indicates sucess or failure of the REST request. |
boolean |
None. |
Updated |
Number of invoices that were updated. |
int |
None. |
Response Formats
application/json, text/json
{ "ErrorCode": "None", "ErrorID": "sample string 1", "ErrorNum": 0, "ErrorMessages": [ "sample string 1", "sample string 2" ], "Errors": 2, "Inserted": 3, "InvoiceCount": 4, "Invoices": [ { "Address": "sample string 3", "Address2": "sample string 4", "AmountDue": 1.0, "BillerInvoiceNo": "sample string 5", "BillerRemittanceField1": "sample string 6", "BillerRemittanceField2": "sample string 7", "BillerRemittanceField3": "sample string 8", "BillerRemittanceField4": "sample string 9", "BillerRemittanceField5": "sample string 10", "City": "sample string 11", "CompanyName": "sample string 12", "Country": "sample string 13", "CurrentCharges": 1.0, "CustomAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Details": [ { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" }, { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" } ], "DisplayField1": "sample string 14", "DisplayField2": "sample string 15", "DisplayField3": "sample string 16", "DisplayField4": "sample string 17", "DisplayField5": "sample string 18", "DueDate": "2025-05-21T06:35:30.2341001Z", "EIR": true, "Email": "test1@test.com", "EntryField1": "sample string 20", "EntryField2": "sample string 21", "EntryField3": "sample string 22", "EntryField4": "sample string 23", "EntryField5": "sample string 24", "ExternalID": "sample string 26", "Fax": "sample string 28", "FDICode": "sample string 29", "FirstName": "sample string 30", "ID": 31, "InvoiceAge": 32, "InvAltTaxAmount": 1.0, "InvAltTaxAmtItmLevel": 1.0, "InvAltTaxIdItmLevel": "sample string 33", "InvAltTaxIDOrdLevel": "sample string 34", "InvAltTaxID": "sample string 35", "InvAltTaxRate": "sample string 36", "InvAltTaxType": "sample string 37", "InvAltTaxTypeApp": "sample string 38", "InvCommodityCode": "sample string 39", "InvCustomerCode": "sample string 40", "InvDestAddress1": "sample string 41", "InvDestAddress2": "sample string 42", "InvDestCardholderName": "sample string 43", "InvDestCity": "sample string 44", "InvDestCountryCode": "sample string 45", "InvDestStateCode": "sample string 46", "InvDestZipCode": "sample string 47", "InvDiscountPerItem": 1.0, "InvDutyAmount": 1.0, "InvFreightAmount": 1.0, "InvLineItemTotal": 1.0, "InvLineItemDiscountRate": "sample string 48", "InvLineItemTaxRate": "sample string 49", "InvLineItemVATTaxAmount": 1.0, "InvLineItemVATTaxRate": "sample string 50", "InvLocalTaxAmount": 1.0, "InvLocalTaxItmLevel": 1.0, "InvLocalTaxRate": "sample string 51", "InvMerchantVATRegistrationNumber": "sample string 52", "InvNationalTaxAmount": 1.0, "InvNationalTaxItmLevel": 1.0, "InvNationalTaxRate": "sample string 53", "InvNetGrossIndicator": "sample string 54", "InvOrderDisAmtOrdLevel": "sample string 55", "InvProductCode": "sample string 56", "InvProductName": "sample string 57", "InvProductSKU": "sample string 58", "InvPurchaseID": "sample string 59", "InvPurchaseIDItmLevel": "sample string 60", "InvPstTaxRegNum": "sample string 61", "InvRequestorName": "sample string 62", "InvQuantity": 1, "InvShipFromZipCode": "sample string 63", "InvSummaryCommodityCode": "sample string 64", "InvSupplierOrdRef": "sample string 65", "InvTaxAmount": 1.0, "InvTaxRate": "sample string 66", "InvUnitCost": 1.0, "InvUnitMeasure": "sample string 67", "InvVatRefNumber": "sample string 68", "InvVatRegNumber": "sample string 69", "InvVatTaxAmount": 1.0, "InvVatTaxRate": "sample string 70", "LastName": "sample string 74", "MerchantDescriptor": "sample string 75", "MerchantDescriptorAlt": "sample string 76", "MerchantDescriptorCity": "sample string 77", "MerchantDescriptorContact": "sample string 78", "MerchantDescriptorCountry": "sample string 79", "MerchantDescriptorState": "sample string 80", "MerchantDescriptorStreet": "sample string 81", "MerchantDescriptorZip": "sample string 82", "Message_OutstandingBalance": "sample string 83", "MiddleName": "sample string 84", "MinimumAmountDue": 1.0, "OtherData": "sample string 85", "PaymentInstrumentBlock": "sample string 86", "PaymentReceived": 1.0, "PaymentsPostedAsOfDate": "2025-05-21T06:35:30.2497208Z", "PayThisAmount": 1.0, "Phone": "sample string 87", "Prev_0To30Days": 1.0, "Prev_30To60Days": 1.0, "Prev_60To90Days": 1.0, "Prev_90DaysPlus": 1.0, "PreviousBalance": 1.0, "ReferenceNumber": "sample string 88", "State": "sample string 89", "StatementDate": "2025-05-21T06:35:30.2497208Z", "Status": "Active", "TotalAccountBalance": 1.0, "WaiveFee": true, "Zip": "sample string 90" }, { "Address": "sample string 3", "Address2": "sample string 4", "AmountDue": 1.0, "BillerInvoiceNo": "sample string 5", "BillerRemittanceField1": "sample string 6", "BillerRemittanceField2": "sample string 7", "BillerRemittanceField3": "sample string 8", "BillerRemittanceField4": "sample string 9", "BillerRemittanceField5": "sample string 10", "City": "sample string 11", "CompanyName": "sample string 12", "Country": "sample string 13", "CurrentCharges": 1.0, "CustomAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Details": [ { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" }, { "ItemDesc": "sample string 1", "ItemFromDate": "sample string 2", "ItemNetAmount": "sample string 3", "ItemNum": "sample string 4", "ItemOrderQty": "sample string 5", "ItemQtyShipped": "sample string 6", "ItemToDate": "sample string 7", "ItemUnitPrice": "sample string 8" } ], "DisplayField1": "sample string 14", "DisplayField2": "sample string 15", "DisplayField3": "sample string 16", "DisplayField4": "sample string 17", "DisplayField5": "sample string 18", "DueDate": "2025-05-21T06:35:30.2341001Z", "EIR": true, "Email": "test1@test.com", "EntryField1": "sample string 20", "EntryField2": "sample string 21", "EntryField3": "sample string 22", "EntryField4": "sample string 23", "EntryField5": "sample string 24", "ExternalID": "sample string 26", "Fax": "sample string 28", "FDICode": "sample string 29", "FirstName": "sample string 30", "ID": 31, "InvoiceAge": 32, "InvAltTaxAmount": 1.0, "InvAltTaxAmtItmLevel": 1.0, "InvAltTaxIdItmLevel": "sample string 33", "InvAltTaxIDOrdLevel": "sample string 34", "InvAltTaxID": "sample string 35", "InvAltTaxRate": "sample string 36", "InvAltTaxType": "sample string 37", "InvAltTaxTypeApp": "sample string 38", "InvCommodityCode": "sample string 39", "InvCustomerCode": "sample string 40", "InvDestAddress1": "sample string 41", "InvDestAddress2": "sample string 42", "InvDestCardholderName": "sample string 43", "InvDestCity": "sample string 44", "InvDestCountryCode": "sample string 45", "InvDestStateCode": "sample string 46", "InvDestZipCode": "sample string 47", "InvDiscountPerItem": 1.0, "InvDutyAmount": 1.0, "InvFreightAmount": 1.0, "InvLineItemTotal": 1.0, "InvLineItemDiscountRate": "sample string 48", "InvLineItemTaxRate": "sample string 49", "InvLineItemVATTaxAmount": 1.0, "InvLineItemVATTaxRate": "sample string 50", "InvLocalTaxAmount": 1.0, "InvLocalTaxItmLevel": 1.0, "InvLocalTaxRate": "sample string 51", "InvMerchantVATRegistrationNumber": "sample string 52", "InvNationalTaxAmount": 1.0, "InvNationalTaxItmLevel": 1.0, "InvNationalTaxRate": "sample string 53", "InvNetGrossIndicator": "sample string 54", "InvOrderDisAmtOrdLevel": "sample string 55", "InvProductCode": "sample string 56", "InvProductName": "sample string 57", "InvProductSKU": "sample string 58", "InvPurchaseID": "sample string 59", "InvPurchaseIDItmLevel": "sample string 60", "InvPstTaxRegNum": "sample string 61", "InvRequestorName": "sample string 62", "InvQuantity": 1, "InvShipFromZipCode": "sample string 63", "InvSummaryCommodityCode": "sample string 64", "InvSupplierOrdRef": "sample string 65", "InvTaxAmount": 1.0, "InvTaxRate": "sample string 66", "InvUnitCost": 1.0, "InvUnitMeasure": "sample string 67", "InvVatRefNumber": "sample string 68", "InvVatRegNumber": "sample string 69", "InvVatTaxAmount": 1.0, "InvVatTaxRate": "sample string 70", "LastName": "sample string 74", "MerchantDescriptor": "sample string 75", "MerchantDescriptorAlt": "sample string 76", "MerchantDescriptorCity": "sample string 77", "MerchantDescriptorContact": "sample string 78", "MerchantDescriptorCountry": "sample string 79", "MerchantDescriptorState": "sample string 80", "MerchantDescriptorStreet": "sample string 81", "MerchantDescriptorZip": "sample string 82", "Message_OutstandingBalance": "sample string 83", "MiddleName": "sample string 84", "MinimumAmountDue": 1.0, "OtherData": "sample string 85", "PaymentInstrumentBlock": "sample string 86", "PaymentReceived": 1.0, "PaymentsPostedAsOfDate": "2025-05-21T06:35:30.2497208Z", "PayThisAmount": 1.0, "Phone": "sample string 87", "Prev_0To30Days": 1.0, "Prev_30To60Days": 1.0, "Prev_60To90Days": 1.0, "Prev_90DaysPlus": 1.0, "PreviousBalance": 1.0, "ReferenceNumber": "sample string 88", "State": "sample string 89", "StatementDate": "2025-05-21T06:35:30.2497208Z", "Status": "Active", "TotalAccountBalance": 1.0, "WaiveFee": true, "Zip": "sample string 90" } ], "Rejected": 5, "Success": true, "Updated": 7 }