Payments

A payment is a transaction used to record a payment against an invoice or an adjustment/debit memo. For more information, see Payments from customers in the Sage Intacct Help Center.

List payments

get/objects/accounts-receivable/payment

Returns a collection with a key, ID, and link for each payment. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2

Responses

200

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": [{"key": "212",
"id": "212",
"href": "/objects/accounts-receivable/payment/212"
},
{"key": "201",
"id": "201",
"href": "/objects/accounts-receivable/payment/201"
},
{"key": "289",
"id": "289",
"href": "/objects/accounts-receivable/payment/289"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": 101,
"previous": null
}
}

Create a payment

post/objects/accounts-receivable/payment

Creates a new payment. To successfully create a payment, you must include either the entityId for a financialEntity or the id for an undepositedGLAccount in your request.

SecurityOAuth2

Request

Request Body schema: application/json
required

One of:

An AR payment is a transaction used to record a payment against an AR invoice or an AR adjustment/debit memo.

required

object

Undeposited funds account associated with this payment.

id	string or null Undeposited funds account number. Example: "1501"
key	string or null Unique key for the undeposited funds account. Example: "356"

paymentMethod

required

string

Payment Method

Enum: "cash" "creditCard" "eft" "onlineAchDebit" "onlineChargeCard" "printedCheck"

Example: "printedCheck"

payerName

string

Name of the payer.

Example: "NF Power and Light"

object

Financial account from which the payment will be made.

entityId

string

Financial entity ID, such as a checking account ID.

Example: "CHK002"

state

string

Default: "complete"

State of the AR payment. The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation.

Enum: "complete" "draft" "reconciled" "reversal" "reversed"

Example: "complete"

object

Multi-entity payment details.

documentNumber

string

Document number, such as a check number.

Example: "1567"

description

string <= 1000 characters

Memo or notes about the AR payment.

Example: "Regular payment for services"

object

For multi-currency companies, the company's base currency.

currency	string The company's base currency. Example: "USD"
amountToPay	string <decimal-precision-2> Amount to pay in the base currency. Example: "500"

object

Transaction currency for the payment.

Example: "USD"

currency required	string The currency in which the payment was made. Example: "USD"
amountToPay	string <decimal-precision-2> Amount to pay in the transaction currency. Example: "500"
totalAmount	string <decimal-precision-2> <= 14 characters Total transaction amount. Example: "100.00"

referenceNumber

string or null <= 21 characters

Reference number, which can be a transaction number from the bank or a document number.

Example: "1234"

object

AR summary the payment is part of. Summaries are collections of transactions grouped together for processing.

Example: "2024-01-23"

receiptDate required	string <date> Posting date for the AR payment. Example: "2024-01-23"
key	string <= 8 characters Unique key for the AR summary. Example: "1259"
id	string ID for the AR summary. Example: "1259"
title	string Title of the AR summary. Example: "Receipts (Bank-CHK0002): Batch 02-07-2024"
name	string <= 100 characters Name of the AR summary. Example: "Feb 2024 batch"

object

Customer associated with the AR payment.

Example: "1"

id required	string <= 21 characters ID for the customer. Example: "Cust-00064"
key	string Unique key for the customer. Example: "45"
name	string Name of the customer, which is usually the company name. Example: "Gomez Manufacturers"

object

Supporting document for the payment.

key	string Unique key for the attachment. Example: "123"
id	string ID for the attachment. Example: "123"

paidDate

string <date>

Date when the invoice was fully paid.

Example: "2024-01-23"

object

Overpayments can be applied to future invoices and can be tagged to specific dimensions for future use.

customerId	string Customer who made the payment. Example: "C-00013"
locationId	string ID of the location to assign any overpayment amount to. Example: "CA"
departmentId	string ID of the department to assign any overpayment amount to. Example: "04"
classId	string ID of the class to assign any overpayment amount to. Example: "Class1"
projectId	string ID of the project to assign any overpayment amount to. Example: "11"

overPaymentAmount

string <decimal-precision-2>

Amount of the overpayment. When a payment is received that exceeds what the customer owes on all invoices and the amount of the payment is entered, Sage Intacct tracks the excess as an overpayment.

Example: "100.20"

object

Contact information for the AR payment.

object

Pay-to contact for the AR payment.

key	string Unique key for the pay-to contact. Example: "8"
id	string ID for the pay-to contact. Example: "Klay Vanderbilt"

Array of objects

Details for the AR payment.

Array

discountDate	string <date> Date the discount was applied. Example: "2024-04-30"
	object For multi-currency companies, base currency information for the payment detail.
	object For multi-currency companies, transaction currency information for the payment detail. Example: "100"
	object Inline transaction record details.
	object Inline transaction line item record.
	object Negative invoice transaction record.
	object Negative invoice transaction line item record.
	object AR adjustment transaction record.
	object AR adjustment transaction line item record.
	object AR invoice record. Example: "1"
	object AR invoice line item record.
	object AR advance record.
	object AR advance line item record.
	object AR posted overpayment record.
	object AR posted overpayment line item record.
	object Positive adjustment record.
	object Positive adjustment line item record.

Array of objects

Line items of the AR payment.

Array

memo	string Memo or brief description of the AR payment line item. Example: "Annual service charge"
	object Transaction allocation template for the line item, which distributes the invoice amount across specified dimensions.
	object General Ledger (GL) account associated with the line item.
	object The GL account where the system posts offsets to this line item.
	object

Responses

201

Created

400

Bad Request

Request samples

application/json

{"financialEntity": {"entityId": "BOA"
},
"paymentMethod": "cash",
"customer": {"id": "Cust-00064"
},
"documentNumber": "1567",
"paymentSummary": {"receiptDate": "2024-03-23"
},
"txnCurrency": {"currency": "USD"
},
"baseCurrency": {"currency": "USD"
},
"paymentDetails": [{"arInvoice": {"id": "2085"
},
"txnCurrency": {"paymentAmount": "60.00"
}
}
]
}

Response samples

application/json

{"ia::result": {"id": "2096",
"key": "2096",
"href": "/objects/accounts-receivable/payment/2096"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Get a payment

get/objects/accounts-receivable/payment/{key}

Returns detailed information for a specified payment.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the payment.

Example: 67

Responses

200

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": {"id": "464",
"key": "464",
"paymentSummary": {"key": "281",
"id": "281",
"title": "Receipts(Bank-BOA): 2024/10/10 Batch",
"receiptDate": "2024-10-10",
"name": "Receipts(Bank-BOA): 2024/10/10 Batch",
"href": "/objects/accounts-receivable/summary/281"
},
"undepositedGLAccount": {"key": null,
"id": null
},
"recordType": "rp",
"financialEntity": {"entityId": "BOA",
"entityType": "ba",
"name": "Bank of America",
"currency": "USD"
},
"state": "complete",
"paymentMethod": "cash",
"customer": {"key": "8",
"entity": "C100",
"id": "C-000012",
"name": "Gomez Manufacturers",
"href": "objects/accounts-receivable/customer/8"
},
"payerName": null,
"documentNumber": "1567",
"description": "Regular payment for services",
"audit": {"createdDateTime": "2024-10-10T00:00:00Z",
"modifiedDateTime": "2024-12-12T06:51:22Z",
"createdByUser": {"key": "39",
"href": "/objects/company-config/user/39"
},
"createdBy": "39",
"modifiedByUser": {"key": "39",
"href": "/objects/company-config/user/39"
},
"modifiedBy": "39"
},
"paidDate": "2024-11-20",
"baseCurrency": {"currency": "USD",
"totalAmount": "250",
"totalSelected": "0",
"totalPaid": "250",
"totalDue": "0"
},
"txnCurrency": {"currency": "GBP",
"totalAmount": "250",
"totalSelected": "0",
"totalPaid": "250",
"totalDue": "0"
},
"exchangeRate": {"date": "2024-08-01",
"typeId": "GBP-Rate",
"rate": 3
},
"contacts": {"payTo": {"id": "Klay Vanderbilt",
"key": "8"
}
},
"bankReconciliationStatus": "false",
"bankReconciliationDate": null,
"referenceNumber": null,
"attachment": {"id": "123",
"key": "123",
"href": "/objects/company-config/attachment/123"
},
"entity": {"key": "1",
"id": "1",
"name": "United States of America",
"href": "/objects/company-config/entity/1"
},
"multiEntityPayment": {"key": "1077",
"id": "PAY-00136",
"href": "/objects/accounts-receivable/payment/1077"
},
"lines": [{"id": "1011",
"key": "1011",
"arPayment": {"key": "464",
"id": "464",
"href": "/objects/accounts-receivable/payment/464"
},
"glAccount": {"key": "36",
"id": "1200",
"name": "Accounts Receivable",
"href": "/objects/general-ledger/account/36"
},
"baseCurrency": {"amount": "10",
"currency": "USD",
"totalPaid": "10",
"totalSelected": "0"
},
"txnCurrency": {"amount": "10",
"currency": "GBP",
"totalPaid": "10",
"totalSelected": "0"
},
"dimensions": {"department": {"key": "2",
"id": "9",
"name": "Engineering"
},
"location": {"key": "1",
"id": "1",
"name": "United States of America",
"href": "/objects/company-config/location/1"
},
"customer": {"key": "20",
"id": "C-00013",
"href": "/objects/accounts-receivable/customer/20"
},
"vendor": {"key": null,
"id": null,
"name": null
},
"employee": {"key": null,
"id": null,
"name": null
},
"item": {"key": "227",
"id": "API3.0",
"name": "API Usage",
"href": "/objects/inventory-control/item/227"
},
"contract": {"key": "61",
"id": "62176",
"name": "62176",
"href": "/objects/contracts/contract/61"
},
"project": {"key": null,
"id": null,
"name": null
},
"class": {"key": null,
"id": null,
"name": null
}
},
"memo": "Regular payment for services",
"exchangeRate": {"date": "2024-10-10",
"typeId": "3",
"rate": 3
},
"lineNumber": 1,
"recordType": "rp",
"offsetGLAccount": {"key": "9",
"id": "4000",
"href": "/objects/general-ledger/account/9"
},
"audit": {"createdDateTime": "2024-12-12T06:51:21Z",
"modifiedDateTime": "2024-12-12T06:51:22Z",
"createdByUser": {"key": "38",
"href": "/objects/company-config/user/38"
},
"createdBy": "38",
"modifiedByUser": {"key": "38",
"href": "/objects/company-config/user/38"
},
"modifiedBy": "38"
},
"href": "/objects/accounts-receivable/payment-line/1011"
}
],
"paymentDetails": [{"id": "127",
"key": "127",
"baseCurrency": {"paymentAmount": "10",
"inlineAmount": null,
"postedAdvanceAmount": null,
"postedOverPaymentAmount": null,
"negativeInvoiceAmount": null,
"adjustmentAmount": null
},
"txnCurrency": {"inlineAmount": null,
"postedAdvanceAmount": null,
"postedOverPaymentAmount": null,
"negativeInvoiceAmount": null,
"adjustmentAmount": null,
"paymentAmount": "10.00",
"currency": "GBP"
},
"arInvoice": {"id": "406",
"key": "406",
"href": "/objects/accounts-receivable/invoice/406"
},
"arInvoiceLine": {"id": "886",
"key": "886",
"href": "/objects/accounts-receivable/invoice-line/886"
},
"positiveAdjustment": {"key": null,
"id": null
},
"positiveAdjustmentLine": {"id": null,
"key": null
},
"inlineTxn": {"key": null,
"id": null
},
"inlineTxnLine": {"id": null,
"key": null
},
"postedAdvance": {"key": null,
"id": null
},
"postedAdvanceLine": {"id": null,
"key": null
},
"arPostedOverPayment": {"key": null,
"id": null
},
"arPostedOverPaymentLine": {"id": null,
"key": null
},
"postedOverPayment": {"key": null,
"id": null
},
"postedOverPaymentLine": {"id": null,
"key": null
},
"negativeInvoice": {"key": null,
"id": null
},
"negativeInvoiceLine": {"id": null,
"key": null
},
"arAdjustment": {"key": null,
"id": null
},
"arAdjustmentLine": {"id": null,
"key": null
},
"arAdvance": {"key": null,
"id": null
},
"arAdvanceLine": {"id": null,
"key": null
},
"arPayment": {"id": "464",
"key": "464",
"href": "/objects/accounts-receivable/payment/464"
},
"arPaymentLine": {"id": "1011",
"key": "1011",
"href": "/objects/accounts-receivable/payment-line/1011\""
},
"paymentDate": "2024-03-20",
"audit": {"createdDateTime": "2024-12-12T06:51:21Z",
"modifiedDateTime": "2024-12-12T06:51:21Z",
"createdByUser": {"key": "1",
"href": "/objects/company-config/user/1"
},
"createdBy": "1",
"modifiedByUser": {"key": "1",
"href": "/objects/company-config/user/1"
},
"modifiedBy": "1"
},
"href": "/objects/accounts-receivable/payment-detail/127"
}
],
"href": "/objects/accounts-receivable/payment/464"
},
"ia::meta": {"totalCount": 1
}
}

Delete a draft payment

delete/objects/accounts-receivable/payment/{key}

Deletes a draft payment.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the payment.

Example: 67

Responses

204

No Content

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "A POST request requires a payload",
"errorId": "REST-1028",
"additionalInfo": {"messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
"placeholders": {"OPERATION": "POST"
},
"propertySet": { }
},
"supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 0,
"totalError": 1
}
}

Payments

List payments

Create a payment

Request Body schema: application/jsonrequired

Get a payment

path Parameters

Delete a draft payment

path Parameters

Request Body schema: application/json
required