Advances

Advances allow you to make a payment to a vendor in advance of receiving a bill. For example, if a vendor requires an up-front deposit, create an advance payment and post it to an established prepayment account.

List advances

get/objects/accounts-payable/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": "625510",
      • "id": "625510",
      • "href": "/objects/accounts-payable/advance/625510"
      },
    • {
      • "key": "558105",
      • "id": "558105",
      • "href": "/objects/accounts-payable/advance/558105"
      },
    • {
      • "key": "558543",
      • "id": "558543",
      • "href": "/objects/accounts-payable/advance/558543"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an advance
post/objects/accounts-payable/advance
Creates a new advance.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
paymentMethod
required
string
Payment method for the AP advance. A payment method for AP advances defines how funds are transferred to a vendor, which determines the approval process and workflow steps needed to complete the advance payment.


 Enum: "ach" "cash" "creditCard" "eft" "printedCheck"  
 Example:  "printedCheck"
required
object
Financial account from which the reconciliation is done.


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


 
 Example:  "BOA"
advanceDate
required
string <date> 
Date the advance payment was made.


 
 Example:  "2021-01-23"
referenceNumber
string or null
A number, such as a purchase order or account number, useful for searches or reports. This number appears on the GL Details report and is printed on checks and vendor stubs.


 
 Example:  "INV-902852"
description
string or null
Description of the AP advance.


 
 Example:  "Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges."
state
string
 Default:  "draft"
Processing state of the AP advance.
The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation.


 Enum: "advancePaid" "declined" "draft" "fullyApplied" "inProcess" "partiallyApplied" "partiallyApproved" "pendingApproval" "void" "voided"  
 Example:  "draft"
object
 
key
string
Location key


 
 Example:  "1"
id
string
Location ID


 
 Example:  "US"
dueDate
string <date> 
Due date for the AP advance.


 
 Example:  "2021-01-23"
object
 
clearingDate
string or null <date> 
The date when reconciliation is completed. This value is automatically populated.


 
 Example:  "2021-01-23"
cleared
string
 Default:  "false"
Indicates the reconciliation status.


 Enum: "false" "matched" "true"  
 Example:  "false"
isSystemGenerated
string
 Default:  "false"
Indicates whether the advance record is created by the system. A value of true means it is system-generated and not based on user input.


 Enum: "false" "true"  
 Example:  "true"
object
Currency details for this AP advance.


 
txnCurrency
required
string
The transaction currency to use for this advance. If this currency is different from the base currency, provide an exchange rate.


 
 Example:  "USD"
baseCurrency
string
Base currency for the AP advance.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string or null <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
number or null
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string or null
The type of exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Supporting document ID for this attachment.


 
key
string or null
 
 Example:  "21"
id
string or null
 
 Example:  "Sales01"
object
Vendor associated with the AP advance.


 
id
required
string
Unique identifier for the vendor.


 
 Example:  "Vendor_01"
key
string
System-assigned unique key for the vendor.


 
 Example:  "15"
name
string
Name of the vendor.


 
 Example:  "Logic Solutions"
Array of objects
Line items of the advance.


 
 Array 
txnAmount
required
string <decimal-precision-2> 
The transaction amount for the AP advance line item in the currency specified for the transaction.


 
 Example:  "100"
required
object
 
object
 
memo
string or null
Additional notes or comments about the advance line item for reference.


 
 Example:  "Service charges"
object
Base location for the line item.


 
object
Meaningful name of the account.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "description": "Advance for new equipment",
  • "paymentMethod": "cash",
  • "financialEntity": {
    • "id": "BOA"
    },
  • "advanceDate": "2023-07-23",
  • "vendor": {
    • "id": "1099 Int"
    },
  • "lines": [
    • {
      • "baseAmount": "12.34",
      • "memo": "Advance payment to vendor for retainer fee - to be applied against future invoices.",
      • "txnAmount": "1.23",
      • "dimensions": {
        },
      • "glAccount": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "625530",
    • "id": "625530",
    • "href": "/objects/accounts-payable/advance/625530"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an advance
get/objects/accounts-payable/advance/{key}
Returns detailed information for a specified advance.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "20",
    • "key": "20",
    • "recordType": "pr",
    • "paymentMethod": "eft",
    • "description": null,
    • "advanceSummary": {
      • "id": "399",
      • "key": "399",
      • "name": "Advances(Bank-BOA) 2024/10/23 21:21:03:5361 Batch",
      • "href": "/objects/accounts-payable/summary/399"
      },
    • "vendor": {
      • "name": "1099 Int",
      • "id": "1099 Int",
      • "key": "43",
      • "totalDue": "-120.00",
      • "href": "/objects/accounts-payable/vendor/43"
      },
    • "totalEntered": "120.00",
    • "paymentInformation": {
      • "totalPaid": "0.00",
      • "totalSelected": "0.00",
      • "paidDate": "2024-05-20",
      • "txnTotalPaid": "0.00",
      • "txnTotalSelected": "0.00"
      },
    • "totalDue": "120.00",
    • "state": "advancePaid",
    • "audit": {
      • "createdDateTime": "2024-05-20T00:00:00Z",
      • "modifiedDateTime": "2024-05-20T08:39:25Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "id": "1",
      • "key": "1",
      • "name": "United States of America"
      },
    • "dueDate": "2024-05-20",
    • "referenceNumber": "Advace for 1099 Int",
    • "reconciliationGroup": {
      • "cleared": "false",
      • "clearingDate": null
      },
    • "isSystemGenerated": "false",
    • "currency": {
      • "txnCurrency": "USD",
      • "baseCurrency": "USD",
      • "exchangeRate": {
        }
      },
    • "txnTotalEntered": "120.00",
    • "txnTotalDue": "120.00",
    • "location": {
      • "key": "1"
      },
    • "financialEntity": {
      • "id": "BOA"
      },
    • "advanceDate": "2024-05-20",
    • "attachment": {
      • "id": "Invc-001",
      • "key": "2",
      • "href": "/objects/company-config/attachment/2"
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/accounts-payable/advance/20"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an advance
patch/objects/accounts-payable/advance/{key}
Updates an existing advance by setting field values. Any fields not provided remain unchanged. You can only update advances in a draft state or advances that were declined during the approval process.


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


 
 Example:  99
Request Body schema: application/json
paymentMethod
string
Payment method for the AP advance. A payment method for AP advances defines how funds are transferred to a vendor, which determines the approval process and workflow steps needed to complete the advance payment.


 Enum: "ach" "cash" "creditCard" "eft" "printedCheck"  
 Example:  "printedCheck"
referenceNumber
string or null
A number, such as a purchase order or account number, useful for searches or reports. This number appears on the GL Details report and is printed on checks and vendor stubs.


 
 Example:  "INV-902852"
description
string or null
Description of the AP advance.


 
 Example:  "Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges."
state
string
 Default:  "draft"
Processing state of the AP advance.
The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation.


 Enum: "advancePaid" "declined" "draft" "fullyApplied" "inProcess" "partiallyApplied" "partiallyApproved" "pendingApproval" "void" "voided"  
 Example:  "draft"
advanceDate
string <date> 
Date the advance payment was made.


 
 Example:  "2021-01-23"
object
 
key
string
Location key


 
 Example:  "1"
id
string
Location ID


 
 Example:  "US"
dueDate
string <date> 
Due date for the AP advance.


 
 Example:  "2021-01-23"
object
Financial account from which the reconciliation is done.


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


 
 Example:  "BOA"
object
 
clearingDate
string or null <date> 
The date when reconciliation is completed. This value is automatically populated.


 
 Example:  "2021-01-23"
cleared
string
 Default:  "false"
Indicates the reconciliation status.


 Enum: "false" "matched" "true"  
 Example:  "false"
isSystemGenerated
string
 Default:  "false"
Indicates whether the advance record is created by the system. A value of true means it is system-generated and not based on user input.


 Enum: "false" "true"  
 Example:  "true"
object
Currency details for this AP advance.


 
baseCurrency
string
Base currency for the AP advance.


 
 Example:  "USD"
txnCurrency
string
The transaction currency to use for this advance. If this currency is different from the base currency, provide an exchange rate.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string or null <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
number or null
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string or null
The type of exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Supporting document ID for this attachment.


 
key
string or null
 
 Example:  "21"
id
string or null
 
 Example:  "Sales01"
object
Vendor associated with the AP advance.


 
id
string
Unique identifier for the vendor.


 
 Example:  "Vendor_01"
key
string
System-assigned unique key for the vendor.


 
 Example:  "15"
name
string
Name of the vendor.


 
 Example:  "Logic Solutions"
Array of objects
Line items of the advance.


 
 Array 
txnAmount
string <decimal-precision-2> 
The transaction amount for the AP advance line item in the currency specified for the transaction.


 
 Example:  "100"
object
 
memo
string or null
Additional notes or comments about the advance line item for reference.


 
 Example:  "Service charges"
object
Base location for the line item.


 
object
Meaningful name of the account.


 
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Updated description of advance"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "625529",
    • "id": "625529",
    • "href": "/objects/accounts-payable/advance/625529"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an advance
delete/objects/accounts-payable/advance/{key}
Deletes an advance. Only draft advances can be deleted.


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


 
 Example:  99
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
    }
}