Advances

Advances record an advance payment from a customer before creating an invoice, for example, when a customer provides a retainer.

List advances

get/objects/accounts-receivable/advance

Returns a collection with a key, ID, and link for each advance. 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

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "621",
      • "id": "621",
      • "href": "/objects/accounts-receivable/advance/621"
      },
    • {
      • "key": "777",
      • "id": "777",
      • "href": "/objects/accounts-receivable/advance-line/777"
      },
    • {
      • "key": "802",
      • "id": "802",
      • "href": "/objects/accounts-receivable/advance-line/802"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an advance
post/objects/accounts-receivable/advance
Creates a new advance.
If Accounts Receivable automatic summaries are enabled, you must include either a financialEntity in paymentInformation or a glAccount with an undepositedGLAccountNumber to successfully create an advance. 
If the Accounts Receivable application is configured to Enable Account Labels, you must include an accountLabel in the items array to create an advance.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
referenceNumber
string
This is a number that might be useful in searches or reports, such as a transaction number from the bank, a purchase order number, or an account number. This number is listed in the GL Details report.


 
 Example:  "INV-902852"
description
string
Brief description of the advance payment.


 
 Example:  "08/31/21 Subscription charges"
state
string
Processing state of the AR advance.
The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation.


 Enum: "draft" "fullyApplied" "partiallyApplied" "posted" "reconciled" "reversal" "reversed" "selected"  
 Example:  "posted"
totalEntered
string <decimal-precision-2> 
Total amount of the AR advance.


 
 Example:  "100.00"
txnTotalEntered
string <decimal-precision-2> 
Total transaction amount of the AR advance.


 
 Example:  "200.20"
object
Payment information for the AR advance.


 
 Example:  {"paymentDate":"2024-05-10","paymentMethod":"cash","receiptDate":"2024-05-10"}
paymentDate
required
string <date> 
Date the advance was paid.


 
 Example:  "2024-05-10"
paymentMethod
required
string
Payment method for the advance.


 Enum: "ach" "cash" "creditCard" "eft" "printedCheck"  
 Example:  "cash"
receiptDate
required
string <date> 
The date on which the check, cash, credit card, or bank transfer for the advance was received.


 
 Example:  "2024-05-10"
object
Financial account from which the reconciliation is done.


 
id
string
Account number or other unique ID for the bank account.


 
 Example:  "BOA"
object
 
exchangeRateDate
string <date> 
Exchange rate date


 
 Example:  "2014-01-08"
exchangeRateTypeId
string
Exchange rate type


 
 Example:  "Intacct Daily Rate"
exchangeRate
number
Exchange rate


 
 Example:  0.78
baseCurrency
string
Base currency


 
 Example:  "USD"
txnCurrency
string
Transaction currency


 
 Example:  "GBP"
object
The payment summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing.


 
key
string
Unique key for the summary.


 
 Example:  "280"
id
string
ID for the summary.


 
 Example:  "280"
object
Customer from whom the advance was received.


 
 Example:  "1"
id
required
string
ID of the customer.


 
 Example:  "Customer_01"
key
string
Unique key for the customer.


 
 Example:  "23"
name
string
Name of the customer.


 
 Example:  "Logic Solutions"
object
GL account associated with the advance.


 
id
string
General ledger account number.


 
 Example:  "1501"
key
string
Unique key for the general ledger account.


 
 Example:  "356"
undepositedGLAccountNumber
string
Undeposited funds account number for the general ledger account.


 
 Example:  "100444"
object
Supporting document for the advance.


 
key
string
System-assigned key for the attachment.


 
 Example:  "21"
id
string
ID for the attachment.


 
 Example:  "Sales01"
Array of objects
Line items of the advance.


 
 Example:  [{"txnAmount":{"id":"100"}}]
 Array 
txnAmount
required
string <decimal-precision-2> 
Amount for the AR advance line item in the transaction currency.


 
 Example:  {"id":"100"}
memo
string
Memo about the line item.


 
 Example:  "Service charges"
object
Currency details for the advance line item.


 
object
Payment information for the AR advance line item.


 
object
 
object
 
object
 
 Example:  {"glAccount":{"id":"4010"}}
object
 
 Example:  {"location":{"id":"1"}}
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "customer": {
    • "id": "C-00019"
    },
  • "paymentInformation": {
    • "paymentDate": "2024-06-13",
    • "receiptDate": "2024-06-13",
    • "paymentMethod": "printedCheck",
    • "financialEntity": {
      • "id": "BOA"
      }
    },
  • "advanceSummary": {
    • "id": "511"
    },
  • "items": [
    • {
      • "glAccount": {
        },
      • "accountLabel": {
        },
      • "txnAmount": "500",
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "799",
    • "id": "799",
    • "href": "/objects/accounts-receivable/advance/799",
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}
Get an advance
get/objects/accounts-receivable/advance/{key}
Returns detailed information for a specified advance.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the advance.


 
 Example:  757
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "1169",
    • "key": "1169",
    • "advanceSummary": {
      • "id": "300",
      • "key": "300",
      • "href": "/objects/accounts-receivable/summary/300"
      },
    • "paymentInformation": {
      • "financialEntity": {
        },
      • "paymentMethod": "cash",
      • "currency": {
        },
      • "receiptDate": "2024-06-13",
      • "paymentDate": "2024-06-13",
      • "totalSelected": "0.00",
      • "txnTotalSelected": "0.00",
      • "totalPaid": "0.00",
      • "txnTotalPaid": "0.00",
      • "totalDue": "10.00",
      • "totalTxnAmountDue": "10.00"
      },
    • "glAccount": {
      • "undepositedGLAccountNumber": "1070"
      },
    • "customer": {
      • "id": "Cust_ForInvoice_0021",
      • "name": "Cust_ForInvoice_0021"
      },
    • "referenceNumber": "Number10",
    • "description": "Advance 10",
    • "advanceNumber": "Advance-001",
    • "recordType": "rr",
    • "state": "posted",
    • "totalEntered": "10.00",
    • "txnTotalEntered": "10.00",
    • "audit": {
      • "createdDateTime": "2024-06-13T00:00:00Z",
      • "modifiedDateTime": "2024-06-26T05:51:05Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "createdDate": "2024-06-13",
    • "reconciliationGroup": {
      • "cleared": "false",
      • "clearingDate": "2024-06-13"
      },
    • "isSystemGenerated": false,
    • "attachment": {
      • "id": "10"
      },
    • "deposit": {
      • "id": "234",
      • "key": "234"
      },
    • "items": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/advance/1169"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an advance
patch/objects/accounts-receivable/advance/{key}
Updates an existing advance by setting field values. Any fields not provided remain unchanged. Advances that have not yet been applied to an invoice can be updated. The General Ledger account book for the advance must also be open. If an advance was applied to an invoice and later unapplied, it cannot be updated.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the advance.


 
 Example:  757
Request Body schema: application/json
referenceNumber
string
This is a number that might be useful in searches or reports, such as a transaction number from the bank, a purchase order number, or an account number. This number is listed in the GL Details report.


 
 Example:  "INV-902852"
description
string
Brief description of the advance payment.


 
 Example:  "08/31/21 Subscription charges"
totalEntered
string <decimal-precision-2> 
Total amount of the AR advance.


 
 Example:  "100.00"
txnTotalEntered
string <decimal-precision-2> 
Total transaction amount of the AR advance.


 
 Example:  "200.20"
object
Payment information for the AR advance.


 
paymentDate
string <date> 
Date the advance was paid.


 
 Example:  "2021-01-23"
paymentMethod
string
Payment method for the advance.


 Enum: "ach" "cash" "creditCard" "eft" "printedCheck"  
 Example:  "printedCheck"
receiptDate
string <date> 
The date on which the check, cash, credit card, or bank transfer for the advance was received.


 
 Example:  "2024-01-25"
object
Financial account from which the reconciliation is done.


 
id
string
Account number or other unique ID for the bank account.


 
 Example:  "BOA"
object
 
exchangeRateDate
string <date> 
Exchange rate date


 
 Example:  "2014-01-08"
exchangeRateTypeId
string
Exchange rate type


 
 Example:  "Intacct Daily Rate"
exchangeRate
number
Exchange rate


 
 Example:  0.78
baseCurrency
string
Base currency


 
 Example:  "USD"
txnCurrency
string
Transaction currency


 
 Example:  "GBP"
object
The payment summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing.


 
key
string
Unique key for the summary.


 
 Example:  "280"
id
string
ID for the summary.


 
 Example:  "280"
object
Customer from whom the advance was received.


 
id
string
ID of the customer.


 
 Example:  "Customer_01"
key
string
Unique key for the customer.


 
 Example:  "23"
name
string
Name of the customer.


 
 Example:  "Logic Solutions"
object
GL account associated with the advance.


 
id
string
General ledger account number.


 
 Example:  "1501"
key
string
Unique key for the general ledger account.


 
 Example:  "356"
undepositedGLAccountNumber
string
Undeposited funds account number for the general ledger account.


 
 Example:  "100444"
object
Supporting document for the advance.


 
key
string
System-assigned key for the attachment.


 
 Example:  "21"
id
string
ID for the attachment.


 
 Example:  "Sales01"
Array of objects
Line items of the advance.


 
 Array 
txnAmount
string <decimal-precision-2> 
Amount for the AR advance line item in the transaction currency.


 
 Example:  "100"
memo
string
Memo about the line item.


 
 Example:  "Service charges"
object
Currency details for the advance line item.


 
object
Payment information for the AR advance line item.


 
object
 
object
 
object
 
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "referenceNumber": "DOC1234"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "799",
    • "id": "799",
    • "href": "/objects/accounts-receivable/advance/799",
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}
Delete an advance
delete/objects/accounts-receivable/advance/{key}
Deletes an advance.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the advance.


 
 Example:  757
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": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}