Connection Information

URL: https://<SPECTRUM-SERVER>:8482/customer/invoice

Authentication: Basic Authentication, Enhanced Authentication

Supported methods: POST

Supported formats: JSON

Sample JSON Body

{
	"arInvoices":[
		{
			"Company_Code":"ABC",
			"GL_Date":"05/24/2018",
			"Batch_Code":"20180524",
			"Customer_Code":"007Cor",
			"Job_Number":"",
			"Invoice_Or_Transaction":"081317_1",
			"Transaction_Type":"I",
			"Invoice_Date":"05/24/2018",
			"Terms_Code":"1",
			"Salesperson_Code":"",
			"Sales_Tax_Code":"",
			"Sales_Tax_Amount":"",
			"Retention_Percent":0,
			"Print_Job_Address_Flag":"",
			"Remarks":"",
			"Customer_PO":"PO123456",
			"AR_GL_Account":"",
			"Retention_Amount":"",
			"VAT_Code":"",
			"Total_VAT_Amount":"",
			"Asset_Cost_Center":"101",
			"invoiceDetails":[
				{
					"Quantity":55,
					"Detail_Description":"An Item",
					"Unit_Of_Measure":"EA",
					"Line_Extension":467.75,
					"GL_Account":"204200",
					"Taxable_Flag":"Y",
					"Income_Cost_Center":"100",
					"Message":""
				},
				{
					"Quantity":0,
					"Detail_Description":"",
					"Unit_Of_Measure":"",
					"Line_Extension":0,
					"GL_Account":"",
					"Taxable_Flag":"N",
					"Income_Cost_Center":"",
					"Message":"Here is a message"
				},
				{
					"Quantity":55,
					"Detail_Description":"equipment",
					"Unit_Of_Measure":"HRS",
					"Line_Extension":467.75,
					"GL_Account":"204200",
					"Taxable_Flag":"Y",
					"Income_Cost_Center":"100",
					"Message":""
				},
				{
					"Quantity":0,
					"Detail_Description":"",
					"Unit_Of_Measure":"",
					"Line_Extension":20,
					"GL_Account":"",
					"Taxable_Flag":"N",
					"Income_Cost_Center":"",
					"Message":""
				},
				{
					"Quantity":55,
					"Detail_Description":"",
					"Unit_Of_Measure":"EA",
					"Line_Extension":467.75,
					"GL_Account":"204200",
					"Taxable_Flag":"N",
					"Income_Cost_Center":"100",
					"Message":""
				},
				{
					"Quantity":55,
					"Detail_Description":"",
					"Unit_Of_Measure":"EA",
					"Line_Extension":467.75,
					"GL_Account":"204200",
					"Taxable_Flag":"N",
					"Income_Cost_Center":"100",
					"Message":""
				}
			]
		}
	]
}

Assumptions and Dependencies

• The General Ledger date and Invoice date must be within the Accounts Receivable processing date. Based on the Accounts Receivable Installation option the General Ledger date and Invoice date may need to be in the same GL period.

• The import requires that Line_Extension, Sales_Tax_Amount, and Retention_Amount contain a positive number. If a negative retention is needed, then the Transaction_Type needs to be defined as a C(redit Memo) to provide a negative retention number.

• The import allows the user to import retention-only records which will require the Line_Extension and Retention_Amount to have the same defined value.

• Sales tax code and Invoice date will be used to define the percentage for the header. Sales tax codes must be set up; if the rates are different than the rates defined in the Historical table, Spectrum will use the closest date.

• Value Added Tax (VAT)

  • GL Installation option that allows the user to add functionality to use Value Added Tax logic.

    • If selected then the Invoice header contains additional fields appear for the VAT code and amount and the Sales Tax field name changes to PST and the Retention name changes to Holdback.

    • The VAT is calculated on the total Invoice amount.

  • If selected then the VAT_Code and Total_VAT_Amt can be defined on the Invoice header.

  • VAT_Code default hierarchy

    • The Job Classification File Maintenance provides an option to override the default VAT on the Customer invoice. If defined then use this code.

    • If the Job Classification is not selected then default from the GL Installation screen otherwise use the defined code contained in the service.

  • Total_VAT_Amt can be either calculated based on the defined VAT_Code or overwritten by the defined value in the layout.

• Cost center information will only be allowed if the Company is set to a 'Yes' status.

• The transaction data being submitted using this web service are stored within the Customer Invoice Entry screen; the data must manually be updated within Spectrum.

Header Elements

Use the table below for reference when using this service.

Detail Elements

Use the table below for reference when using this service.