Advances

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

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List advances

get/objects/accounts-receivable/advance

Returns a collection with a key, ID, and link for each advance.

Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Advances
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 accountType is set to or defaults to bank, financialEntity is required to create an advance. If accountType is set to undepositedFundsAccount, a glAccount with an undepositedGLAccountNumber is required to create an advance.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness (with all admin privileges), Employee, CRM


PermissionsList, View, Add Advances







SecurityOAuth2 
Request 
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.


 
 Example:  {"paymentDate":"2024-05-10","paymentMethod":"cash","receiptDate":"2024-05-10"}
paymentDate
required
string <date> 
Date the AR 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 identifier 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"
accountType
string
 Default:  "bank"
Type of account associated with the payment method. If accountType is set to or defaults to bank, financialEntity is required to create an advance. If accountType is set to undepositedFundsAccount, a glAccount with an undepositedGLAccountNumber is required to create an advance.


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


 
key
string
System-assigned key to uniquely identify the summary.


 
 Example:  "280"
id
string
System-assigned 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
System-assigned key for the customer.


 
 Example:  "23"
name
string
Customer name.


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


 
id
string
General ledger account number.


 
 Example:  "1501"
key
string
System-assigned 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.


 
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": "cash"
    },
  • "advanceSummary": {
    • "id": "AR Advance Summary"
    },
  • "items": [
    • {
      • "glAccount": {
        },
      • "txnAmount": "10",
      • "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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness, Employee, Project Manager, and Warehouse users


PermissionsList, View Advances







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


 
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",
    • "recordType": "rr",
    • "state": "posted",
    • "totalEntered": "10.00",
    • "txnTotalEntered": "10.00",
    • "audit": {
      • "modifiedDateTime": "2024-06-26T05:51:05Z",
      • "createdBy": "1",
      • "modifiedBy": "1",
      • "createdDateTime": "2024-06-13T00:00:00Z"
      },
    • "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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness, Employee, Project Manager, and Warehouse users


PermissionsList, View, Edit Advances







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


 
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 AR 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 identifier 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"
accountType
string
 Default:  "bank"
Type of account associated with the payment method. If accountType is set to or defaults to bank, financialEntity is required to create an advance. If accountType is set to undepositedFundsAccount, a glAccount with an undepositedGLAccountNumber is required to create an advance.


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


 
key
string
System-assigned key to uniquely identify the summary.


 
 Example:  "280"
id
string
System-assigned 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
System-assigned key for the customer.


 
 Example:  "23"
name
string
Customer name.


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


 
id
string
General ledger account number.


 
 Example:  "1501"
key
string
System-assigned 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.


 
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
      }
    }
}
Query advances
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-receivable/advance"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}