List Invoices
Retrieves List of invoices from the database. The data returned from this API will be paged Paging supported.
get
Authorizations
AuthorizationstringRequired
Query parameters
idnumberOptional
A comma-separated list of invoice ids.
invoice_numberstringOptional
A comma-separated list of invoice numbers.
so_numberstringOptional
A comma-separated list of sales order numbers.
customer_namestringOptional
A comma-separated list of customer names.
third_party_ref_nostringOptional
A comma-separated list of third party reference numbers.
ref_nostringOptional
A comma-separated list of invoice reference numbers.
store_namestringOptional
A comma separated list of stores.
created_at_minstringOptional
Show invoices created at or after date (format: 2014-04-25T16:15:47-04:00).
updated_at_minstringOptional
Show invoices updated at or after date (format: 2014-04-25T16:15:47-04:00).
created_at_maxstringOptional
Show invoices created at or before date (format: 2014-04-25T16:15:47-04:00).
updated_at_maxstringOptional
Show invoices updated at or before date (format: 2014-04-25T16:15:47-04:00).
statusstringOptional
A comma-separated list of statuses.
has_shipmentbooleanOptional
Boolean value that controls whether invoices with "Pick Up" or non-"Pick Up" terms are fetched.
header_onlybooleanOptional
Decides if only the header data to be returned. Default = false.
pagenumberRequired
Page number for the query result set. Default = 1
since_idstringOptional
Return records with an identifier greater than this value.
third_party_customer_idstringOptional
Customer identifier from the external system.
third_party_company_idstringOptional
Company or account identifier from the external system.
exclude_processedbooleanOptionalDefault:
When true, excludes records already marked as processed.
falseso_ref_nostringOptional
Sales order reference number.
third_party_sourcestringOptional
Name of the external system or channel that supplied the transaction.
querystringOptional
Search text used by the endpoint where supported.
Responses
200
OK
application/json
IsForwardRequestbooleanOptional
MessagestringOptional
MessageTitlestring · nullableOptional
ResultbooleanOptional
get/api/xerp/invoice/getinvoice
GET /api/xerp/invoice/getinvoice?page=1 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*
200
OK
{
"Data": [
{
"ImportError": null,
"IsBeingAutoCreated": false,
"SimulatationFlag": false,
"invoiceHeader": {
"AccntReceivableId": "B78BD2985430878CEFF97D8C436F",
"AccntReceivableName": "AR2 USD",
"AmountDue": 489.63,
"AmountPaid": 0,
"AmountToPay": 0,
"AuthorizationDetailList": null,
"AutoCreateCarrierFlag": false,
"BatchUploadFlag": false,
"BillToAddr": "1312 Seymour Cir",
"BillToAddr2": "",
"BillToAddrName": null,
"BillToCity": "Lincoln",
"BillToCompanyName": "",
"BillToCountry": "USA",
"BillToEmail": "",
"BillToFirstName": "",
"BillToLastName": "",
"BillToName": "",
"BillToPhoneNumber": "",
"BillToState": "CA",
"BillToZpCode": "95648",
"BrandId": null,
"BrandName": null,
"BuyerId": null,
"BuyerName": null,
"CarrierId": 1321,
"CarrierName": "UPS",
"CounterNumber": null,
"CreateDttm": "03/22/2020 10:42:58 PM",
"CreateSource": "xtest10012",
"CreditApplied": 0,
"CurrencyCode": "USD",
"CurrencyId": 1001,
"CurrencyName": "USD",
"CurrencySymbol": "$ ",
"CustomFieldH1": null,
"CustomFieldH10": null,
"CustomFieldH11": null,
"CustomFieldH12": null,
"CustomFieldH13": null,
"CustomFieldH14": null,
"CustomFieldH15": null,
"CustomFieldH16": null,
"CustomFieldH17": null,
"CustomFieldH18": null,
"CustomFieldH19": null,
"CustomFieldH2": null,
"CustomFieldH20": null,
"CustomFieldH21": null,
"CustomFieldH22": null,
"CustomFieldH23": null,
"CustomFieldH24": null,
"CustomFieldH25": null,
"CustomFieldH26": null,
"CustomFieldH27": null,
"CustomFieldH28": null,
"CustomFieldH29": null,
"CustomFieldH3": null,
"CustomFieldH30": null,
"CustomFieldH4": null,
"CustomFieldH5": null,
"CustomFieldH6": null,
"CustomFieldH7": null,
"CustomFieldH8": null,
"CustomFieldH9": null,
"CustomerDefaultBillingEmail": null,
"CustomerDefaultShipmentEmail": null,
"CustomerEmailCC": null,
"CustomerEmailMain": null,
"CustomerFirstName": null,
"CustomerFullName": "Customer 1",
"CustomerGroupId": 9,
"CustomerId": 6113,
"CustomerLastName": null,
"CustomerMainPhone": null,
"CustomerMessage": "",
"CustomerName": "Customer 1",
"CustomerPO": "123456",
"CustomerServiceRepFullName": null,
"CustomerServiceRepId": null,
"CustomerTaxCodeId": 1002,
"DepositApplied": 30,
"DiscountAccntId": null,
"DiscountAccntName": null,
"DiscountAmount": 0,
"DiscountApplied": 0,
"DiscountDate": null,
"DiscountToUse": 0,
"DiscountableAmount": 0,
"DueDate": "03/22/2020",
"EmailedFlag": false,
"ErrorOnTaxMismatch": false,
"ExchangeRate": 1,
"ExchangeRateFormula": null,
"FobId": 20,
"FobName": "Destination",
"FullPaymentDate": null,
"Id": 23104,
"ImportError": null,
"IntAccntId": null,
"InvoiceNumber": "MAIN-I002651",
"ItemIncomeAccountId": null,
"ItemIncomeAccountName": null,
"LastEmailDttm": null,
"LastOverdueEmailDttm": null,
"MatchedFlag": false,
"MaxDiscountAllowed": 0,
"Memo": "This is a memo",
"ModifyDttm": null,
"ModifySource": "",
"NoTaxCompareFlag": false,
"OldTxnDate": "03/22/2020",
"OpeningBalanceFlag": false,
"PaymentTermsId": 10,
"PaymentTermsName": "COD",
"ProjectClassId": 1,
"ProjectClassName": "Online",
"ReCalcShippingTaxesFlag": false,
"ReCalcTaxesFlag": false,
"RefId": null,
"RefNo": "MAIN-S003607 | RefNo203892-1",
"ReportDataObj": {
"EntityAccntId": "C7A82F0E-53F2-4934-875F-BBA04F907FCB",
"EntityName": "Customer 1",
"ReportEntityId": 108,
"TxnRefId": 23104,
"TxnRefNumber": "MAIN-I002651",
"TxnTypeId": 109
},
"ReportingDataText": null,
"RiskAnalysis": null,
"SaleStoreCode": null,
"SaleStoreId": 10002,
"SaleStoreName": "Main Warehouse",
"SalesRepEmail": "xoyecis@yopmail.com",
"SalesRepFullName": "Derek Brad",
"SalesRepId": "dbrad",
"ShipDate": "03/22/2020",
"ShipMethodId": 30,
"ShipMethodName": "Delivery (Third Party)",
"ShipServiceId": 58,
"ShipServiceName": "UPS Ground",
"ShipToAddr": "1312 Seymour Cir",
"ShipToAddr2": "",
"ShipToAddrName": null,
"ShipToCity": "Lincoln",
"ShipToCompanyName": "",
"ShipToCountry": "USA",
"ShipToEmail": "",
"ShipToFirstName": "",
"ShipToLastName": "",
"ShipToName": "",
"ShipToPhoneNumber": "",
"ShipToState": "CA",
"ShipToZpCode": "95648",
"ShipmentId": null,
"ShippingAmount": 107.25,
"ShippingCost": 100,
"ShippingCostCarrier": 0,
"ShippingCostCredited": null,
"ShippingNotes": "This is Shipping Notes",
"ShippingTaxCodeId": 1000,
"ShippingTaxCodeName": "CA TAX 7.25%",
"ShippingTaxData": {
"taxItems": [
{
"itemAmount": 7.25,
"itemId": 1000,
"itemName": "CA TAX 7.25%",
"itemRatePerc": 7.25,
"lineAmount": 100
}
],
"totalAmount": 7.25
},
"ShippingTaxDataSerialized": null,
"ShippingTaxItems": [
{
"Id": 1000,
"Name": "CA TAX 7.25%",
"Rate": 0.0725,
"RateType": "percentage",
"TotalAmount": 7.25
}
],
"ShippingTermsId": 30,
"ShippingTermsName": "Prepaid & Billed",
"ShippingTypeId": 10,
"ShippingTypeName": "Flat/Standard",
"SoId": 23897,
"SoNumber": null,
"SoSubTypeId": null,
"SoToInvoice": false,
"StatusId": 510,
"StatusName": "Partially Paid",
"StoreCode": null,
"StoreId": 10002,
"StoreName": "Main Warehouse",
"SubTotal": 0,
"SubTotalExclDiscount": 0,
"SysLockFlag": false,
"Tags": "TagX,TagY",
"TaxCalcByAddress": false,
"TaxCalcType": null,
"TaxOperationCountryCode": null,
"TaxSummaryDataText": null,
"ThirdPartyDefaultSKU": null,
"ThirdPartyDisplayName": " Shopify",
"ThirdPartyIconUrl": "https://image-url-for-source",
"ThirdPartyRefNo": "Order123",
"ThirdPartySource": "Shopify-Account1",
"ThirdPartyTotalAmount": null,
"ThirdPartyTotalTaxAmount": null,
"TotalAmount": 519.63,
"TotalPaidAmount": 30,
"TotalQty": 0,
"TotalTaxAmount": 35.13,
"TrackingNumbers": "1Z3W777R6854236880",
"TxnDate": "03/22/2020",
"TxnId": "72D3567091F366515CA7DF25F4265",
"TxnNumber": 38005,
"TxnTypeId": null,
"TypeId": 10,
"UnPostTranFlag": false,
"UseDefaultSKUWhenError": false,
"WaveNumbers": "MAIN-W002032",
"searchField": null
},
"invoiceItemLineArr": [
{
"AuthorizationDetailList": null,
"BaseUomId": 4,
"BaseUomName": "",
"CreateDttm": "01/01/0001 12:00:00 AM",
"CreateSource": null,
"CreditQty": 0,
"CustomFieldD1": "",
"CustomFieldD10": "",
"CustomFieldD11": "",
"CustomFieldD12": "",
"CustomFieldD13": "",
"CustomFieldD14": "",
"CustomFieldD15": "",
"CustomFieldD16": "",
"CustomFieldD17": "",
"CustomFieldD18": "",
"CustomFieldD19": "",
"CustomFieldD2": "",
"CustomFieldD20": "",
"CustomFieldD21": "",
"CustomFieldD22": "",
"CustomFieldD23": "",
"CustomFieldD24": "",
"CustomFieldD25": "",
"CustomFieldD26": "",
"CustomFieldD27": "",
"CustomFieldD28": "",
"CustomFieldD29": "",
"CustomFieldD3": "",
"CustomFieldD30": "",
"CustomFieldD4": "",
"CustomFieldD5": "",
"CustomFieldD6": "",
"CustomFieldD7": "",
"CustomFieldD8": "",
"CustomFieldD9": "",
"DeleteFlag": false,
"Description": "Battery Connector",
"Discount": 50,
"DiscountTypeId": 10,
"DiscountTypeName": "percentage",
"EditState": true,
"EffectiveUnitPrice": 384.5,
"ExternalItemNumber": "",
"ForceSalesTaxCode": false,
"HasRestriction": null,
"Id": 29908,
"InventoryLocChangeList": null,
"InvoiceId": 23104,
"IsTaxableFlag": true,
"IsoCode2": "",
"IsoCountryName": "",
"ItemId": 30111,
"ItemNumber": "BC",
"ItemTypeId": 10,
"ItemTypeName": "Inventory",
"LineNumber": 1,
"ModifyDttm": null,
"ModifySource": null,
"OldQty": 1,
"ProjectClassId": null,
"ProjectClassName": "",
"Qty": 1,
"QtyDecimalFlag": false,
"RefId": null,
"RestrictionOverrideFlag": null,
"RestrictionOverridePrice": null,
"RestrictionOverrideUser": "",
"SellUomId": 4,
"SellUomName": "Each",
"SoId": 23897,
"SoLineId": 40668,
"SoNumber": "MAIN-S003607",
"StatusId": 510,
"TaxAmount": 27.8763,
"TaxCodeId": 1000,
"TaxCodeName": "CA TAX 7.25%",
"TaxData": {
"taxItems": [
{
"itemAmount": 27.8763,
"itemId": 1000,
"itemName": "CA TAX 7.25%",
"itemRatePerc": 7.25,
"lineAmount": 384.5
}
],
"totalAmount": 27.8763
},
"TaxItems": [
{
"Id": 1000,
"Name": "CA TAX 7.25%",
"Rate": 0.0725,
"RateType": "percentage",
"TotalAmount": 27.8763
}
],
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"TotalAmount": 384.5,
"TxnId": "72D3567091F366515CA7DF25F4265",
"TxnNumber": 38005,
"TxnTypeId": null,
"UnitPrice": 769,
"UomFactor": 0,
"VASItemCost": null,
"VASItemId": null,
"VASItemName": ""
}
],
"shipCartonArr": null
}
],
"IsForwardRequest": false,
"Message": "Invoice data loaded successfully",
"MessageTitle": null,
"Result": true
}Last updated
Was this helpful?