Intact Accelerate - Intact iQ API
CustomerLedger
Invoice Payment
[GET]
Key Purpose Sample Description
accountCode Account Code (Required) http://localhost:8096//CustomerLedger?accountCode=CUS000001 Account Code for the customer which has the orders you wish to view
number Order Number http://localhost:8096//CustomerLedger?accountCode=CUS000001&number=SOR0000001 Number for the ledger item(s) which you wish to bring back
reference Alternate Reference http://localhost:8096//CustomerLedger?accountCode=CUS000001&reference=A000001 Alternate reference for the ledger item(s) which you wish to bring back
currency Debit Amount http://localhost:8096//CustomerLedger?accountCode=CUS000001¤cy=GBP Currency in which invoice values are to be listed
debitamount Debit Amount http://localhost:8096//CustomerLedger?accountCode=CUS000001&debitamount=123.45 Debit amount of the ledger item(s) which you wish to bring back
fromDate From Date http://localhost:8096//CustomerLedger?accountCode=CUS000001&fromDate=2020-01-01T00:00:00 Oldest date for the ledger item(s) which you wish to bring back
toDate To Date http://localhost:8096//CustomerLedger?accountCode=CUS000001&toDate=2020-01-01T00:00:00 Newest date for the ledger item(s) which you wish to bring back
skip Skip http://localhost:8096//CustomerLedger?accountCode=CUS000001&skip=1&fetch=10 How many ledger items you wish to skip
fetch Fetch http://localhost:8096//CustomerLedger?accountCode=CUS000001&skip=1&fetch=10 How many ledger items you wish to bring back
Sample Response

    

			
				

					Name
					Type
					Description
				

				
					

						Items
						List
						List of Customer Ledger Items that have been found
					

				
					

						TotalCount
						Number
						Total number of Customer Ledger Items found, not including your fetch limits
					

				
					

						ErrorMessage
						String
						Error Message if any
					

				
					

						Success
						Boolean
						If the request was successful
					

				
					

						Items[].Id
						long
						Id of invoice
					

				
					

						Items[].Date
						date
						date of invoice
					

				
					

						Items[].DueDate
						date
						Due Date of invoice
					

				
					

						Items[].Number
						string
						Number of invoice
					

				
					

						Items[].Reference
						string
						Customers reference of invoice
					

				
					

						Items[].Type
						long
						Always SL/Inv
					

				
					

						Items[].Debit
						decimal
						Original value of invoice
					

				
					

						Items[].Credit
						decimal
						Original credit value of invoice
					

				
					

						Items[].Unallocated
						decimal
						Outstanding value of invoice
					

				
					

						Items[].Currency
						string
						Currency of invoice
					

				
			
    

  


	
	

	  
    
[POST]

    

			
				

					Key
					Purpose
					Sample
					Description
				

				
					

						Body
						Required
						{accountcode: "06dev",amountpaid:56, DatePaid:"2024-03-04T11:54:22",paymentbranchcode:"LON",receipttypecode:"CC £",
items:[
{Number: "SI6760981", AmountPaid:15},
{Number: "SI6760853", AmountPaid:20},
{Number: "SI6760855", AmountPaid:3}
]}
						
					

				
					

						accountcode
						account code to own the receipt
						
						
					

				
					

						amountpaid
						total sum of receipt/payment
						
						
					

				
					

						receipttypecode
						code of receipt type
						
						
					

				
					

						datepaid
						date of receipt
						
						
					

				
					

						paymentbranchcode
						code of IQ payment branch
						
						
					

				
					

						receipttypecode
						code of IQ receipt type
						
						
					

				
					

						items
						(optional) collection of invoice numbers and amounts
						
						
					

				
					

						items[].number
						number of invoice to be paid 
						
						
					

				
					

						items[].amountpaid
						amount to be paid off this invoice 
						
						
					

				
			
    

	

	

		
Sample Response

    

    

			
				

					Name
					Type
					Description
				

				
					

						Success
						bool
						true when successful operation
					

				
					

						Receipt
						
						Generated Receipt
					

				
					

						Receipt.Number
						string
						Generated receipt number
					

				
					

						Receipt.Amount
						decimal
						Amount of generated receipt 
					

				
					

						Receipt.Unallocated
						decimal
						Amount of generated receipt not allocated to invoices 
					

				
					

						Allocations
						
						Invoices that receipt funds were allocated to
					

				
					

						Allocations[].Number
						string
						Number of receipt that funds were allocated to
					

				
					

						Allocations[].Amount
						decimal
						Value of funds allocated to invoice from receipt 
					

				
					

						Allocations[].Unallocated
						decimal
						Outstanding balance on invoice 
					

				
					

						Errors
						
						Error List