Advance lines

Line items in an advance represent transactions such as down payments or deposits.

List advance lines

get/objects/accounts-payable/advance-line

Returns a collection with a key, ID, and link for each advance line. 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": "1103722",
      • "id": "1103722",
      • "href": "/objects/accounts-payable/advance-line/1103722"
      },
    • {
      • "key": "5145328",
      • "id": "5145328",
      • "href": "/objects/accounts-payable/advance-line/5145328"
      },
    • {
      • "key": "5145339",
      • "id": "5145339",
      • "href": "/objects/accounts-payable/advance-line/5145339"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an advance line
get/objects/accounts-payable/advance-line/{key}
Returns detailed information for a specified advance line.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "39",
    • "key": "39",
    • "apAdvance": {
      • "id": "20",
      • "key": "20",
      • "recordType": "pr",
      • "href": "/objects/accounts-payable/advance/20"
      },
    • "glAccount": {
      • "key": "81",
      • "id": "1304",
      • "name": "Vendor Advances",
      • "href": "/objects/general-ledger/account/81"
      },
    • "accountLabel": {
      • "id": null
      },
    • "baseAmount": "120.00",
    • "txnAmount": "120.00",
    • "dimensions": {
      • "department": {
        },
      • "location": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        },
      • "nsp::refcode_gl": {
        },
      • "nsp::vssn": {
        },
      • "nsp::restriction": {
        }
      },
    • "baseLocation": {
      • "name": "United States of America",
      • "key": "1",
      • "href": "/objects/company-config/location/1"
      },
    • "memo": "Invc-001",
    • "currency": {
      • "exchangeRate": {
        },
      • "baseCurrency": "USD",
      • "txnCurrency": "USD"
      },
    • "lineNumber": 1,
    • "paymentInformation": {
      • "totalPaid": "0.00",
      • "txnTotalPaid": "0.00",
      • "totalSelected": "0.00",
      • "txnTotalSelected": "0.00"
      },
    • "audit": {
      • "createdDateTime": "2024-05-20T08:39:24Z",
      • "modifiedDateTime": "2024-05-20T08:39:25Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/accounts-payable/advance-line/39"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Creates advance lines
post/objects/accounts-payable/advance-line/{key}
Creates new advance lines


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


 
 Example:  99
Request Body schema: application/json
required
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
Meaningful name of the account.


 
key
string or null
System-assigned key for the account label.


 
 Example:  "14"
id
string or null
Unique identifier for the account label.


 
 Example:  "Accounting Fees"
object
 
required
object
Location to assign the expense to.


 
key
string or null
Location key


 
 Example:  "10"
id
string or null
Location ID


 
 Example:  "1"
object
Department to assign the expense to.


 
key
string or null
Department key


 
 Example:  "1"
id
string or null
Department ID


 
 Example:  "1"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key


 
 Example:  "23"
id
string or null
Affiliate entity ID


 
 Example:  "AFF-23"
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.


 
key
string
Location key


 
 Example:  "4"
id
string
Location ID


 
 Example:  "US"
object
 
key
string
Account key


 
 Example:  "144"
id
string
Account ID


 
 Example:  "1112"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "apAdvance": {
    • "key": "89"
    },
  • "txnAmount": "2500.00",
  • "baseAmount": "2500.00",
  • "accountLabel": {
    • "id": "Bank Fees"
    },
  • "dimensions": {
    • "location": {
      • "id": "1"
      },
    • "department": {
      • "id": "4"
      }
    },
  • "memo": "Created memo for advance line charges"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/advance-line/5",
    • "ia::meta": {
      • "totalCount": 1
      }
    }
}
Update advance lines
patch/objects/accounts-payable/advance-line/{key}
Updates advance lines


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


 
 Example:  99
Request Body schema: application/json
required
txnAmount
string <decimal-precision-2> 
The transaction amount for the AP advance line item in the currency specified for the transaction.


 
 Example:  "100"
object
 
object
Location to assign the expense to.


 
key
string or null
Location key


 
 Example:  "10"
id
string or null
Location ID


 
 Example:  "1"
object
Department to assign the expense to.


 
key
string or null
Department key


 
 Example:  "1"
id
string or null
Department ID


 
 Example:  "1"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key


 
 Example:  "23"
id
string or null
Affiliate entity ID


 
 Example:  "AFF-23"
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.


 
key
string
Location key


 
 Example:  "4"
id
string
Location ID


 
 Example:  "US"
object
Meaningful name of the account.


 
key
string or null
System-assigned key for the account label.


 
 Example:  "14"
id
string or null
Unique identifier for the account label.


 
 Example:  "Accounting Fees"
object
 
key
string
Account key


 
 Example:  "144"
id
string
Account ID


 
 Example:  "1112"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "txnAmount": "1300.00"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/advance-line/5",
    • "ia::meta": {
      • "totalCount": 1
      }
    }
}
Delete advance lines
delete/objects/accounts-payable/advance-line/{key}
Delete advance lines


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


 
 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
    }
}