GetInvoices (GET) | GEP TECH DOCUMENTATION

Overview

This GET API allows retrieval of Invoice details created in GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Invoice/All

Request

https://<Instance>/SmartInterfaceAPI/api/Invoice/All

Response

{
   "data": [
      {
         "basicDetails": {
            "documentName": "string",
            "documentNumber": "string",
            "documentStatus": "string",
            "documentCreator": "string",
            "createdOn": "string",
            "documentLobDetails": [
               {
                  "entityCode": "string",
                  "entityType": "string"
               }
            ],
            "operationName": "string"
         },
         "partnerInvoiceNumber": "string",
         "clientPartnerCode": "string",
         "partnerName": "string",
         "partnerInvoiceDate": "2020-05-29T08:14:05.136Z",
         "orderNumber": "string",
         "shiptoLocation": {
            "locationName": "string",
            "locationNumber": "string",
            "address": {
               "addressline1": "string",
               "addressline2": "string",
               "addressline3": "string",
               "city": "string",
               "zipCode": "string",
               "stateInfo": {
                  "stateAbbrevationCode": "string",
                  "stateName": "string"
               },
               "countryInfo": {
                  "countryCode": "string",
                  "countryName": "string"
               },
               "phoneNo1": "string",
               "extenstionNo1": "string",
               "phoneNo2": "string",
               "extenstionNo2": "string",
               "mobileNo": "string",
               "faxNo": "string",
               "county": "string"
            },
            "deliverTo": "string",
            "registrationDetails": [
               {
                  "companyIdentificationDisplayName": "string",
                  "companyIdentification": "string"
               }
            ]
         },
         "matchStatus": "string",
         "billtoLocation": {
            "locationName": "string",
            "locationNumber": "string",
            "address": {
               "addressline1": "string",
               "addressline2": "string",
               "addressline3": "string",
               "city": "string",
               "zipCode": "string",
               "stateInfo": {
                  "stateAbbrevationCode": "string",
                  "stateName": "string"
               },
               "countryInfo": {
                  "countryCode": "string",
                  "countryName": "string"
               },
               "phoneNo1": "string",
               "extenstionNo1": "string",
               "phoneNo2": "string",
               "extenstionNo2": "string",
               "mobileNo": "string",
               "faxNo": "string",
               "county": "string"
            },
            "deliverTo": "string",
            "registrationDetails": [
               {
                  "companyIdentificationDisplayName": "string",
                  "companyIdentification": "string"
               }
            ]
         },
         "orderTotal": 0,
         "orderDate": "2020-05-29T08:14:05.136Z",
         "attachment": {
            "fileName": "string",
            "fileUri": "string",
            "extension": "string",
            "contentTransferEncoding": "string",
            "attachmentData": "string"
         },
         "headerEntities": [
            {
               "entityCode": "string",
               "entityType": "string"
            }
         ],
         "invoiceOrigin": "string",
         "receivedDate": "2020-05-29T08:14:05.136Z",
         "invoiceTotalAmount": 0,
         "orderContactDetails": {
            "clientContactCode": "string",
            "emailAddress": "string",
            "firstName": "string",
            "lastName": "string"
         },
         "orderingLocation": {
            "locationName": "string",
            "locationNumber": "string",
            "address": {
               "addressline1": "string",
               "addressline2": "string",
               "addressline3": "string",
               "city": "string",
               "zipCode": "string",
               "stateInfo": {
                  "stateAbbrevationCode": "string",
                  "stateName": "string"
               },
               "countryInfo": {
                  "countryCode": "string",
                  "countryName": "string"
               },
               "phoneNo1": "string",
               "extenstionNo1": "string",
               "phoneNo2": "string",
               "extenstionNo2": "string",
               "mobileNo": "string",
               "faxNo": "string",
               "county": "string"
            },
            "deliverTo": "string",
            "registrationDetails": [
               {
                  "companyIdentificationDisplayName": "string",
                  "companyIdentification": "string"
               }
            ]
         },
         "isPCardSupported": true,
         "invoiceType": "string",
         "purchaseTypeDescription": "string",
         "buyerVatNumber": "string",
         "billable": true,
         "totalAllowance": 0,
         "isMultiDocInvoice": true,
         "scheduledPaymentDate": "2020-05-29T08:14:05.137Z",
         "currency": "string",
         "itemTotalAmount": 0,
         "tax": 0,
         "shipping": 0,
         "additionalCharges": 0,
         "taxesAndCharges": [
            {
               "taxDescription": "string",
               "taxType": "string",
               "taxMode": "string",
               "taxValue": 0,
               "taxPercentage": 0,
               "taxCode": "string",
               "isAccrueTax": true
            }
         ],
         "comments": [
            {
               "commentText": "string",
               "accessType": "string"
            }
         ],
         "workOrderNumber": "string",
         "erpOrderType": "string",
         "budgetDescription": "string",
         "paymentTermsDetails": {
            "noOfDays": 0,
            "discount": 0,
            "discountDays": 0,
            "paymentTermCode": "string",
            "paymentTermName": "string"
         },
         "supplierIdentificationValue": "string",
         "customAttributes": [
            {
               "questionnaireTitle": "string",
               "questionnaireResponseValues": [
                  {
                     "childQuestionSets": [
                        null
                     ],
                     "columnText": "string",
                     "responseValue": "string",
                     "rowId": "string"
                  }
               ]
            }
         ],
         "sourceSystemName": "string",
         "totalAmount": 0,
         "isMemo": true,
         "remitToLocation": {
            "locationName": "string",
            "locationNumber": "string",
            "address": {
               "addressline1": "string",
               "addressline2": "string",
               "addressline3": "string",
               "city": "string",
               "zipCode": "string",
               "stateInfo": {
                  "stateAbbrevationCode": "string",
                  "stateName": "string"
               },
               "countryInfo": {
                  "countryCode": "string",
                  "countryName": "string"
               },
               "phoneNo1": "string",
               "extenstionNo1": "string",
               "phoneNo2": "string",
               "extenstionNo2": "string",
               "mobileNo": "string",
               "faxNo": "string",
               "county": "string"
            },
            "deliverTo": "string",
            "registrationDetails": [
               {
                  "companyIdentificationDisplayName": "string",
                  "companyIdentification": "string"
               }
            ]
         },
         "supplierContact": {
            "clientContactCode": "string",
            "emailAddress": "string",
            "firstName": "string",
            "lastName": "string"
         },
         "buyerContact": {
            "clientContactCode": "string",
            "emailAddress": "string",
            "firstName": "string",
            "lastName": "string"
         },
         "isBackInvoice": true,
         "paymentType": "string",
         "deliveryNoteNumber": "string",
         "invoiceItems": [
            {
               "itemLineNumber": 0,
               "poLineItemNumber": 0,
               "description": "string",
               "unitPrice": 0,
               "quantity": 0,
               "uom": "string",
               "standardUom": "string",
               "totalAllowance": 0,
               "orderNumber": "string",
               "orderingLocation": {
                  "locationName": "string",
                  "locationNumber": "string",
                  "address": {
                     "addressline1": "string",
                     "addressline2": "string",
                     "addressline3": "string",
                     "city": "string",
                     "zipCode": "string",
                     "stateInfo": {
                        "stateAbbrevationCode": "string",
                        "stateName": "string"
                     },
                     "countryInfo": {
                        "countryCode": "string",
                        "countryName": "string"
                     },
                     "phoneNo1": "string",
                     "extenstionNo1": "string",
                     "phoneNo2": "string",
                     "extenstionNo2": "string",
                     "mobileNo": "string",
                     "faxNo": "string",
                     "county": "string"
                  },
                  "deliverTo": "string",
                  "registrationDetails": [
                     {
                        "companyIdentificationDisplayName": "string",
                        "companyIdentification": "string"
                     }
                  ]
               },
               "externalTax": 0,
               "externalTaxes": [
                  {
                     "taxCode": "string",
                     "taxType": "string",
                     "taxMode": "string",
                     "taxValue": 0,
                     "taxRate": 0,
                     "authorityName": "string",
                     "taxAddress": {
                        "addressline1": "string",
                        "addressline2": "string",
                        "addressline3": "string",
                        "city": "string",
                        "zipCode": "string",
                        "stateInfo": {
                           "stateAbbrevationCode": "string",
                           "stateName": "string"
                        },
                        "countryInfo": {
                           "countryCode": "string",
                           "countryName": "string"
                        },
                        "phoneNo1": "string",
                        "extenstionNo1": "string",
                        "phoneNo2": "string",
                        "extenstionNo2": "string",
                        "mobileNo": "string",
                        "faxNo": "string",
                        "county": "string"
                     },
                     "locationCode": "string",
                     "taxRateCode": "string",
                     "effectiveTaxLevel": "string",
                     "officialName": "string",
                     "taxBase": "string"
                  }
               ],
               "manufacturerName": "string",
               "manufacturerPartNumber": "string",
               "itemType": "string",
               "matchStatus": "string",
               "itemExtendedType": "string",
               "documentItemShippingDetails": [
                  {
                     "shiptoLocation": {
                        "locationName": "string",
                        "locationNumber": "string",
                        "address": {
                           "addressline1": "string",
                           "addressline2": "string",
                           "addressline3": "string",
                           "city": "string",
                           "zipCode": "string",
                           "stateInfo": {
                              "stateAbbrevationCode": "string",
                              "stateName": "string"
                           },
                           "countryInfo": {
                              "countryCode": "string",
                              "countryName": "string"
                           },
                           "phoneNo1": "string",
                           "extenstionNo1": "string",
                           "phoneNo2": "string",
                           "extenstionNo2": "string",
                           "mobileNo": "string",
                           "faxNo": "string",
                           "county": "string"
                        },
                        "deliverTo": "string",
                        "registrationDetails": [
                           {
                              "companyIdentificationDisplayName": "string",
                              "companyIdentification": "string"
                           }
                        ]
                     },
                     "delivertoLocation": {
                        "locationName": "string",
                        "locationNumber": "string",
                        "address": {
                           "addressline1": "string",
                           "addressline2": "string",
                           "addressline3": "string",
                           "city": "string",
                           "zipCode": "string",
                           "stateInfo": {
                              "stateAbbrevationCode": "string",
                              "stateName": "string"
                           },
                           "countryInfo": {
                              "countryCode": "string",
                              "countryName": "string"
                           },
                           "phoneNo1": "string",
                           "extenstionNo1": "string",
                           "phoneNo2": "string",
                           "extenstionNo2": "string",
                           "mobileNo": "string",
                           "faxNo": "string",
                           "county": "string"
                        },
                        "deliverTo": "string",
                        "registrationDetails": [
                           {
                              "companyIdentificationDisplayName": "string",
                              "companyIdentification": "string"
                           }
                        ]
                     },
                     "shippingMethod": "string"
                  }
               ],
               "efforts": 0,
               "startDate": "2020-05-29T08:14:05.137Z",
               "endDate": "2020-05-29T08:14:05.137Z",
               "additionalCharges": 0,
               "shippingCharges": 0,
               "tax": 0,
               "itemTotalAmount": 0,
               "billable": "string",
               "buyerItemNumber": "string",
               "supplierPartId": "string",
               "supplierPartAuxiliaryId": "string",
               "taxes": [
                  {
                     "taxDescription": "string",
                     "taxType": "string",
                     "taxMode": "string",
                     "taxValue": 0,
                     "taxPercentage": 0,
                     "taxCode": "string",
                     "isAccrueTax": true
                  }
               ],
               "customAttributes": [
                  {
                     "questionnaireTitle": "string",
                     "questionnaireResponseValues": [
                        {
                           "childQuestionSets": [
                              null
                           ],
                           "columnText": "string",
                           "responseValue": "string",
                           "rowId": "string"
                        }
                     ]
                  }
               ],
               "comments": [
                  {
                     "commentText": "string",
                     "accessType": "string"
                  }
               ],
               "matchType": "string",
               "isTaxExempt": true,
               "fulfilmentDocumentNumber": "string",
               "fulfilmentDocumentType": "string",
               "fulfillmentDocumentLineNumber": "string",
               "clientCategoryId": "string",
               "adjustmentType": 0,
               "itemSplitsDetails": [
                  {
                     "documentSplitItemEntities": [
                        {
                           "entityType": "string",
                           "entityCode": "string",
                           "entityDisplayName": "string"
                        }
                     ],
                     "tax": 0,
                     "shippingCharges": 0,
                     "additionalCharges": 0,
                     "splitItemTotal": 0,
                     "customAttributes": [
                        {
                           "questionnaireTitle": "string",
                           "questionnaireResponseValues": [
                              {
                                 "childQuestionSets": [
                                    null
                                 ],
                                 "columnText": "string",
                                 "responseValue": "string",
                                 "rowId": "string"
                              }
                           ]
                        }
                     ],
                     "splitType": "string",
                     "quantity": 0,
                     "percentage": 0
                  }
               ]
            }
         ],
         "invoicePreviewURL": "string"
      }
   ],
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "string"
      }
   ]
}

Examples

Success Scenario - Request

Request below describes that this contains only the mandatory attributes:

https://<Instance>/SmartInterfaceAPI/api/Invoice/All

Success Scenario - Response

{
   "data": [
      {
         "BasicDetails": {
            "DocumentCreator": "USKDJU01",
            "CreatedOn": "2020-04-01T18:48:32.653+00:00",
            "DocumentLobDetails": [
               {
                  "EntityCode": "KNA-SAP"
               }
            ],
            "OperationName": "new"
         },
         "PartnerInvoiceNumber": "KetanInv_15052020_03",
         "ClientPartnerCode": "0080005119",
         "PartnerName": "SOUND RESEARCH",
         "PartnerInvoiceDate": "2020-04-01T18:48:32.807+00:00",
         "OrderNumber": "PO75772655-001",
         "ShiptoLocation": {
            "LocationNumber": "0000023617"
         },
         "BilltoLocation": {
            "LocationName": "GBS Center",
            "LocationNumber": "NUNA",
            "Address": {
               "Addressline1": "PO Box 8881011",
               "City": "Grand Rapids",
               "ZipCode": "49588",
               "StateInfo": {
                  "StateAbbrevationCode": "MI"
               },
               "CountryInfo": {
                  "CountryCode": "US",
                  "CountryName": "United States"
               }
            }
         },
         "OrderTotal": 0,
         "OrderDate": "0001-01-01T00:00:00",
         "HeaderEntities": [
            {
               "EntityCode": "NUNA"
            }
         ],
         "InvoiceOrigin": "buyer",
         "ReceivedDate": "2020-04-01T18:48:32.807+00:00",
         "InvoiceTotalAmount": 170,
         "OrderContactDetails": {
            "EmailAddress": "123@gep.com",
            "FirstName": "Kellogg",
            "LastName": "Admin"
         },
         "OrderingLocation": {
            "LocationName": "SOUND RESEARCH",
            "LocationNumber": "0080000010-0080000010",
            "Address": {
               "Addressline1": "250-49 DUNLEVY AVENUE",
               "Addressline2": "",
               "Addressline3": "",
               "City": "VANCOUVER",
               "ZipCode": "V6A 3A3",
               "StateInfo": {
                  "StateAbbrevationCode": "BC"
               },
               "CountryInfo": {
                  "CountryCode": "CA"
               }
            }
         },
         "IsPCardSupported": false,
         "InvoiceType": "Normal",
         "PurchaseTypeDescription": "Standard",
         "Billable": false,
         "TotalAllowance": 0,
         "IsMultiDocInvoice": false,
         "ScheduledPaymentDate": "0001-01-01T00:00:00",
         "Currency": "USD",
         "ItemTotalAmount": 120,
         "Tax": 50,
         "Shipping": 0,
         "AdditionalCharges": 0,
         "TaxesAndCharges": [],
         "Comments": [],
         "WorkOrderNumber": "0",
         "PaymentTermsDetails": {
            "NoOfDays": 0,
            "Discount": 0,
            "DiscountDays": 0,
            "PaymentTermCode": "NT75"
         },
         "CustomAttributes": [],
         "SourceSystemName": "KNA-SAP",
         "TotalAmount": 0,
         "IsMemo": false,
         "RemitToLocation": {
            "LocationName": "SOUND RESEARCH",
            "LocationNumber": "0080005119-0050003639",
            "Address": {
               "Addressline1": "250-49 DUNLEVY AVENUE",
               "City": "VANCOUVER",
               "ZipCode": "V6A 3A3",
               "StateInfo": {
                  "StateAbbrevationCode": "BC"
               },
               "CountryInfo": {
                  "CountryCode": "CA",
                  "CountryName": "Canada"
               },
               "PhoneNo1": "(604) 732-1090",
               "PhoneNo2": "",
               "FaxNo": "(604) 732-1096"
            },
            "RegistrationDetails": []
         },
         "SupplierContact": {
            "EmailAddress": "123@gep.com",
            "FirstName": "David",
            "LastName": "Katz"
         },
         "BuyerContact": {
            "EmailAddress": "aaa123@gep.com"
         },
         "IsBackInvoice": false,
         "InvoiceItems": [
            {
               "ItemLineNumber": 1,
               "PoLineItemNumber": 1,
               "Description": "wiufhiu",
               "UnitPrice": 120,
               "Quantity": 1,
               "Uom": "EA",
               "TotalAllowance": 0,
               "OrderingLocation": {},
               "ExternalTax": 0,
               "ExternalTaxes": [],
               "ItemType": "Material",
               "ItemExtendedType": "Material",
               "DocumentItemShippingDetails": [
                  {
                     "ShiptoLocation": {
                        "LocationNumber": "0000023617",
                        "Address": {
                           "Addressline1": "1 Trade ST",
                           "City": "Mariemont",
                           "ZipCode": "45227-4509",
                           "StateInfo": {
                              "StateName": "OH"
                           },
                           "CountryInfo": {
                              "CountryCode": "1",
                              "CountryName": "United States"
                           }
                        },
                        "RegistrationDetails": []
                     },
                     "DelivertoLocation": {
                        "RegistrationDetails": []
                     }
                  }
               ],
               "Efforts": 0,
               "StartDate": "0001-01-01T00:00:00",
               "EndDate": "0001-01-01T00:00:00",
               "AdditionalCharges": 0,
               "ShippingCharges": 0,
               "Tax": 50,
               "ItemTotalAmount": 120,
               "SupplierPartId": "",
               "Taxes": [],
               "CustomAttributes": [],
               "Comments": [],
               "IsTaxExempt": false,
               "AdjustmentType": 0,
               "ItemSplitsDetails": [
                  {
                     "DocumentSplitItemEntities": [
                        {
                           "EntityType": "Plant",
                           "EntityCode": "1460"
                        },
                        {
                           "EntityType": "Material Group Level 1",
                           "EntityCode": "700"
                        },
                        {
                           "EntityType": "Material Group Level 2",
                           "EntityCode": "8202440"
                        },
                        {
                           "EntityType": "Material Group Level 3",
                           "EntityCode": "735450025"
                        }
                     ],
                     "Tax": 0,
                     "ShippingCharges": 0,
                     "AdditionalCharges": 0,
                     "SplitItemTotal": 120,
                     "CustomAttributes": [],
                     "Quantity": 0,
                     "Percentage": 0
                  }
               ]
            }
         ]
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": []
}

Data Elements

Invoice
Property	Required?	Data type	Description	Validations/Exceptions
BasicDetails		BasicDetails object	Basic Details
IsMultiDocInvoice	No	Boolean	IsMultiDocInvoice
ScheduledPaymentDate	No	DateTime	ScheduledPaymentDate
Currency	Yes	String	Currency	Currency is mandatory Currency Code () is invalid Invoice currency code () does not match with order currency code
ItemTotalAmount	Yes	Decimal	ItemTotalAmount	Charge Amount () cannot be greater than or equal to Invoice Total Amount
Tax	Yes	Decimal	Tax	Tax cannot be negative
Shipping	Yes	String	Shipping	Shipping charges cannot be negative
AdditionalCharges	Yes	DateTime	AdditionalCharges	Additional charges cannot be negative

TaxesAndCharges	Yes	List of TaxesandCharge object	TaxesAndCharges	Tax Values are not matching at Line Item Number
HeaderEntities	Yes	List of HeaderEntities object	Header Entities
Comments	No	List of InterfaceComment object	Comments
WorkOrderNumber	No	String	WorkOrderNumber
ErpOrderType	No	String	ErpOrderType
BudgetDescription	No	String	BudgetDescription
PaymentTermsDetails	No	List of PaymentTermsDetails object	PaymentTermsDetails
SupplierIdentificationValue	No	String	SupplierIdentificationValue
CustomAttribute	Yes	List of CustomAttribute object	CustomAttributes
SourceSystemName	No	String	SourceSystemName
TotalAmount	No	Long	TotalAmount
TotalAllowance	No	Decimal	TotalAllowance
Billable	No	Boolean	Billable
PartnerInvoiceNumber	Yes	String	PartnerInvoiceNumber	Invoice Number is mandatory Partner Invoice Number is duplicate Partner Invoice Number is mandatory
Operation	Yes	String	Operation	Operation is mandatory
DocumentCreator	No	String	DocumentCreator	Order and Invoice Vendor mismatch Invoice Vendor (Client Partner Code) (Source System Name) does not match with order vendor
PartnerName	No	String	PartnerName
PartnerInvoiceDate	Yes	Datetime	PartnerInvoiceDate	Partner Invoice Date is invalid Partner Invoice Date () is invalid
OrderNumber	Yes	String	OrderNumber	Invalid Order
ShiptoLocation	No	List of InterfaceShiptoLocation object	ShiptoLocation	Ship to Location is not sent
MatchStatus	No	String	MatchStatus
BilltoLocation	No	List of InterfaceBilltoLocation object	BilltoLocation
InvoiceItems	Yes	List of InterfaceInvoiceItem object	InvoiceItems
supplierId	No	String	supplierId
OrderTotal	No	Decimal	OrderTotal
OrderDate	No	DateTime	OrderDate
Attachment	No	List of Attachment object	Attachment
InvoiceOrigin	Yes	String	InvoiceOrigin	Invoice Origin is mandatory
ReceivedDate	No	Datetime	ReceivedDate	Invoice received date () is invalid
InvoiceTotalAmount	Yes	Decimal	InvoiceTotalAmount	Total calculation is incorrect Invoice Total is not sent Zero Dollar Invoice
OrderContactDetails	No	List of Order Contact details object	OrderContactDetails
OrderingLocation	No	List of InterfaceLocation object	OrderingLocation
IsPCardSupported	No	Boolean	IsPCardSupported
InvoiceType	No	String	InvoiceType
PurchaseTypeDescription	No	String	PurchaseTypeDescription
BuyerVatNumber	No	String	BuyerVatNumber
IsMemo	No	Boolean	IsMemo
RemitToLocation	Yes	List of InterfaceLocation object	RemitToLocation	Invoice Remit to Location is mandatory
SupplierContact	Yes	List of InterfaceSupplierContact object	SupplierContact
BuyerContacts		List of InterfaceBuyerContact object	BuyerContact
ClientPartnerCode	yes	String	ClientPartnerCode	Supplier (Client Partner Code) does not exists No Vendor sent Vendor is mandatory Vendor () is invalid
IsBackInvoice	No	Boolean	IsBackInvoice
DeliveryNoteNumber	No	String	DeliveryNoteNumber
invoicePreviewURL	No	String	InvoicePreviewURL
PaymentType	No	String	PaymentType

SupplierContact
Property	Required?	Data type	Description	Validations/Exceptions
clientContactCode		String
emailAddress		String
firstName		String
lastName		String

BuyerContact
Property	Required?	Data type	Description	Validations/Exceptions
clientContactCode		String
emailAddress		String
firstName		String
lastName		String

RemitToLocation
Property	Required?	Data type	Description	Validations/Exceptions
locationName		string	Location name
locationNumber		string	Location number
Address		address object	Address
deliverTo		string	deliverTo
RegistrationDetails		registrationDetails object	Registration details

TaxesandCharges
Property	Required?	Data type	Description	Validations/Exceptions
TaxDescription	No	String	TaxDescription
TaxMode	No	Boolean	TaxMode	Invalid tax mode for Item No: ()
TaxValue	No	String	TaxValue
TaxPercentage	No	String	TaxPercentage
TaxCode	No	String	TaxCode	The tax code(s) are not Valid Tax is available at line level
IsAccrueTax	No	String	IsAccrueTax
TaxType	No	String	TaxType

HeaderEntities
Property	Required?	Data type	Description	Validations/Exceptions
entityCode		string	Entity code
entityType		true	Entity Type

BasicDetails
Property	Required?	Data type	Description	Validations/Exceptions
documentName		string	Name of the document
documentNumber		string	Number of the document
documentStatus		string	Status of the document
documentCreator		string	Creator of the document
createdOn		string	Date on which the document is created
documentBu		documentBu object
DocumentLobDetails		documentLobDetails object
operationName		string

Comments
Property	Required?	Data type	Description	Validations/Exceptions
CommentText	No	String	CommentText
AccessType	No	String	AccessType

PaymentTermsDetails
Property	Required?	Data type	Description	Validations/Exceptions
NoOfDays	No	Long	NoOfDays
Discount	No	Decimal	Discount
DiscountDays	No	Long	DiscountDays
PaymentTermCode	No	String	PaymentTermCode	Payment Term (Payment Term Code) is invalid Invoice Payment Term does not match with orders Payment Term
PaymentTermName	No	String	PaymentTermName

DocumentLobDetails
Property	Required?	Data type	Description	Validations/Exceptions
entityCode		string	Entity code
entityType		string	EntityType

ItemSplitsDetails
Property	Required?	Data type	Description	Validations/Exceptions
DocumentSplitItemEntities	No	List of InterfaceDocumentSplit ItemEntity object	DocumentSplitItemEntities
SplitItemTotal	Yes	Decimal	SplitItemTotal	Split Total for Item No: () cannot be negative
Tax	No	Decimal	Tax
ShippingCharges	yes	Decimal	ShippingCharges	Shipping Charges cannot be negative
AdditionalCharges	Yes	Decimal	AdditionalCharges	Additional Charges cannot be negative
CustomAttribute	No	List of CustomAttribute object	CustomAttributes
SplitType	No	String	SplitType
Quantity	No	Decimal	Quantity
Percentage	No	Decimal	Percentage

DocumentSplitItemEntities
Property	Required?	Data type	Description	Validations/Exceptions
EntityType	No	String	EntityType	It has duplicate Accounting entity for Item No:
EntityCode	No	String	EntityCode	There was an error in processing the Invoice as the item(s) :() has invalid Accounting entity code
EntityDisplayName	No	String	EntityDisplayName

CustomAttributes
Property	Required?	Data type	Description	Validations/Exceptions
QuestionnaireTitle	No	String	QuestionnaireTitle	Custom Fields Key text is empty at header
QuestionnaireResponseValues	No	List of QuestionnaireResponse Value object	QuestionnaireResponseValues	Custom Fields Key-Value's Row Id and Column text is missing at header

QuestionNaireResponseValue
Property	Required?	Data type	Description	Validations/Exceptions
ChildQuestionSets	No	List of CustomAttribute object	ChildQuestionSets
ColumnText	No	String	ColumnText	Custom Fields Key text is empty at header Custom Fields Key-Value's Column Text is missing at header
ResponseValue	No	String	ResponseValue
RowId	No	String	RowId	Custom Fields Key-Value's Row Id and Column text is missing at header Custom Fields Key-Value's Row Id is missing at header Custom Fields Key-Value's Row Id is missing/ invalid at header

ChargeDetails
Property	Required?	Data type	Description	Validations/Exceptions
ChargeName	No	String	ChargeName	Invalid Items Invalid Charge Name for Charge Amount () Invalid Items: Invalid Charge Name For below line items
ChargeDescription	No	String	ChargeDescription
IsAllowance	No	Boolean	IsAllowance
IsIncludeForTax	No	Boolean	IsIncludeForTax
IsEditableOnInvoice	No	Boolean	IsEditableOnInvoice

ShiptoLocation
Property	Required?	Data type	Description	Validations/Exceptions
ShiptoLocationName	No	String	ShiptoLocationName	Invalid Ship to Location
ShiptoLocationNumber	No	String	ShiptoLocationNumber	Ship To Location () is invalid
Address	No	List of InterfaceAddress object	Address
DeliverTo	No	String	Deliver To
RegistrationDetails	No	List of PartnerWiseIdentification Detail object	RegistrationDetails

Address
Property	Required?	Data type	Description	Validations/Exceptions
County	No	String	County
FaxNo	No	String	FaxNo
MobileNo	No	String	MobileNo
ExtenstionNo2	No	String	ExtenstionNo2
PhoneNo2	No	String	PhoneNo2
GeoCode	No	String	GeoCode
ExtenstionNo1	No	String	ExtenstionNo1
CountryInfo	No	List of InterfaceCountryInfo object	CountryInfo
StateInfo	No	List of InterfaceStateInfo object	StateInfo
ZipCode	No	String	ZipCode
City	No	String	City
Addressline3	No	String	Addressline3
Addressline2	No	String	Addressline2
Addressline1	No	String	Addressline1
PhoneNo1	No	String	PhoneNo1
AreaCode	No	String	AreaCode

CountryInfo
Property	Required?	Data type	Description	Validations/Exceptions
CountryCode	No	String	CountryCode
CountryName	No	String	CountryName

StateInfo
Property	Required?	Data type	Description	Validations/Exceptions
StateAbbrevationCode	No	String	StateAbbrevationCode
StateName	No	String	StateName

RegistrationDetails
Property	Required?	Data type	Description	Validations/Exceptions
CompanyIdentificationDisplayName	No	String	CompanyIdentificationDisplayName
CompanyIdentification	No	String	CompanyIdentification

BilltoLocation
Property	Required?	Data type	Description	Validations/Exceptions
BilltoLocationName	No	String	BilltoLocationName
BilltoLocationNumber	No	String	BilltoLocationNumber
Address	No	List of InterfaceAddress object	Address
DeliverTo	No	String	Deliver To
RegistrationDetails	No	List of PartnerWiseIdentification Detail object	RegistrationDetails

OrderingLocation
Property	Required?	Data type	Description	Validations/Exceptions
LocationName	No	String	LocationName
LocationNumber	No	String	LocationNumber
Address	No	List of InterfaceAddress object	Address
DeliverTo	No	String	Deliver To
Registration Details	No	List of PartnerWiseIdentification Detail object	RegistrationDetails

InvoiceItems
Property	Required?	Data type	Description	Validations/Exceptions
ShippingCharges	No	Decimal	ShippingCharges
Tax	No	Decimal	Tax	Tax for Item No: () cannot be negative
ItemTotalAmount	No	Decimal	ItemTotalAmount	Sub total Amount for Item No: () cannot be of zero value Invalid Items Charge Amount cannot be greater than or equal to Invoice Line Item total for below line Number(s): ()
Billable	No	String	Billable
ItemLineNumber	No	Long	ItemLineNumber	Invoice Line Number for Item No: ( ) is not a unique Invoice Line Number length is greater than 9 digits for Item No: () Invoice item () is closed for invoicing Length of item line number cannot be greater than 9 digits
SupplierPartId	No	String	SupplierPartId
SupplierPartAuxiliaryId	No	String	SupplierPartAuxiliaryId
Taxes	No	List of TaxesandCharge object	Taxes
CustomAttribute	No	List of CustomAttribute object	CustomAttributes
Comments	No	List of InterfaceComment object	Comments
MatchType	No	String	MatchType
IsTaxExempt	No	Boolean	IsTaxExempt
FulfilmentDocumentNumber	No	String	FulfilmentDocumentNumber
FulfilmentDocumentType	No	String	FulfilmentDocumentType
FulfillmentDocumentLineNumber	No	String	FulfillmentDocumentLineNumber
AdditionalCharges	No	Decimal	AdditionalCharges	Additional charges cannot be negative for item
ClientCategoryId	No	String	ClientCategoryId	Invalid Items () has invalid Client Category Code
EndDate	No	DateTime	EndDate
MatchStatus	No	String	ItemStatus	Invalid Status for Item Line Number(s): ()
ItemSplitsDetails	No	List of ItemSplitsDetail object	ItemSplitsDetails
PoLineItemNumber	No	Long	PoLineItemNumber
TotalAllowance	No	Decimal	TotalAllowance
OrderNumber	No	String	OrderNumber	Order is not in valid status for invoicing
OrderingLocation	No	OrderingLocation object	OrderingLocation
ExternalTax	No	Decimal	ExternalTax
ExternalTaxes	No	List of ExternalTax object	ExternalTaxes
Description		String	Description
UnitPrice	Yes	Decimal	UnitPrice	Unit Price is mandatory for Item No: () Unit Price sign cannot be changed for Item
Quantity	Yes	Decimal	Quantity	Quantity is mandatory for Item No: () Quantity cannot be of Zero Value for Item No: () Quantity sign cannot be changed for Item
Uom	Yes	String	Uom	UOM is mandatory for Item No: () Invoice line number () AS VARCHAR (20)) + ' has invalid UOM code
StandardUom	No	String	StandardUom
ManufacturerName	No	String	ManufacturerName
ManufacturerPartNumber	No	String	ManufacturerPartNumber
ItemType	No	String	ItemType	ItemType For Item No: () is not a valid Item Type
ItemExtendedType	No	String	ItemExtendedType	Item Extended Type for Item No: () cannot be other than Fixed or Variable Item Extended Type for Item No:()is not valid for Service Line Item Item Extended Type for Item No () is not valid for Material Line Item
DocumentItemShippingDetails	No	List of InterfaceDocumentItemShippingDetail object	DocumentItemShippingDetails
StartDate	No	DateTime	StartDate
BuyerItemNumber	No	String	BuyerItemNumber
AdjustmentType	No	Int	AdjustmentType

ExternalTaxes
Property	Required?	Data type	Description	Validations/Exceptions
TaxCode	No	String	TaxCode
TaxType	No	String	TaxType
TaxMode	No	String	TaxMode
TaxValue	No	Decimal	TaxValue
TaxRate	No	Decimal	TaxRate
AuthorityName	No	String	AuthorityName
TaxAddress	No	InterfaceAddress object	TaxAddress
LocationCode	No	String	LocationCode
TaxRateCode	No	String	TaxRateCode
EffectiveTaxLevel	No	String	EffectiveTaxLevel
OfficialName	No	String	OfficialName
TaxBase	No	String	TaxBase

DocumentItemShippingDetail
Property	Required?	Data type	Description	Validations/Exceptions
ShiptoLocation	No	InterfaceShiptoLocation object	ShiptoLocation
DelivertoLocation	No	InterfaceDelivertoLocation object	DelivertoLocation
ShippingMethod	No	string	ShippingMethod

DelivertoLocation
Property	Required?	Data type	Description	Validations/Exceptions
DelivertoLocationName	No	string	DelivertoLocationName
DelivertoLocationNumber	No	string	DelivertoLocationNumber
Address	No	InterfaceAddress Object	Address
DeliverTo	No	string	DeliverTo
RegistrationDetails	No	List of PartnerWiseIdentification Detail object	RegistrationDetails

Attachment
Property	Required?	Data type	Description	Validations/Exceptions
filename		String	File name
fileUri		string	File URL
attachmentData		string	Data in attachment
Extension		string	Extension
contentTransferEncoding		string	Content Transfer Encoding

OrderContactDetails
Property	Required?	Data type	Description	Validations/Exceptions
ClientContactCode	No	String	ClientContactCode	The Invoice Header Entity and Contact Code () should be mapped to same LOB. Requester () is invalid
EmailAddress	No	String	EmailAddress
FirstName	No	String	FirstName
LastName	No	String	LastName