Payments

A payment is a transaction that records a payment against a bill or adjustment. The payment object gives you access to payment details for each payment entry. For example, you can apply line level credits/discounts to a payment entry through one or more payment detail objects.

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 payments

get/objects/accounts-payable/payment

Returns a collection with a key, ID, and link for each payment. This operation is mostly for use in testing; use query 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": "1718",
      • "id": "1718",
      • "href": "/objects/accounts-payable/payment/1718"
      },
    • {
      • "key": "1717",
      • "id": "1717",
      • "href": "/objects/accounts-payable/payment/1717"
      },
    • {
      • "key": "3228",
      • "id": "3228",
      • "href": "/objects/accounts-payable/payment/3228"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a payment
post/objects/accounts-payable/payment
Creates a new payment.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
object
Financial account from which the reconciliation is done.


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


 
 Example:  "BOA"
required
object
Vendor to receive the payment.


 
key
string
System-assigned key of the vendor.


 
 Example:  "201"
id
string
ID of the vendor.


 
 Example:  "V-00014"
paymentMethod
required
string
Payment method for the payment.


 Enum: "ach" "cash" "creditCard" "eft" "jointCheck" "manualCheck" "onlineAchDebit" "onlineChargeCard" "printedCheck"  
 Example:  "printedCheck"
paymentDate
required
string <date> 
The date to make the payment.


 
 Example:  "2021-01-23"
action
string
 Default:  "draft"
The action to take when the payment is created or updated.


    

  • submit - Submit or post the payment, depending on the approval workflow
    • 

  • draft - Move the payment to the outbox in the system
    • 



 Enum: "draft" "submit"  
 Example:  "submit"
documentNumber
string or null
Reference number for the payment, which can be the check number or the transaction number, depending on the payment method used.


 
 Example:  "3086"
description
string or null
Description of the payment (memo).


 
 Example:  "From billing through August 31"
documentId
string or null
Document ID for the payment.


 
 Example:  "Prim-Vendor-Invoice-VI#0008#doc"
object
Transaction totals in base currency.


 
currency
string
The company's base currency.


 
 Example:  "USD"
object
Transaction totals in the currency in which it was paid.


 
currency
required
string
The currency in which the payment was made.


 
 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"
typeId
string or null
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
paymentRequestMethod
string
 Default:  "useVendorPreference"
Determines how request are generated.
If the PAYMENTMETHOD value is "jointCheck" then the PAYMENTREQUESTMETHOD value must be "bill"


 Enum: "generateOneRequestPerBill" "mergeRequestIntoOnePerVendorPayToContact" "mergeRequestsIntoOnePerVendor" "useVendorPreference"  
 Example:  "generateOneRequestPerBill"
Array of objects  non-empty 
Array of details for the payment, including transaction payment amounts, line items, discounts, adjustments, and so forth.


 
 Array (non-empty)
required
object
AP bill to pay.


 
object
Detail amounts in the company's base currency.


 
object
Detail amounts in the transaction currency.


 
discountDate
string or null <date> 
Discount date.


 
 Example:  "2023-04-04"
object
AP adjustment to pay.


 
object
Line item in the AP adjustment.


 
object
Line item in the AP bill.


 
object
ap-payment object that this ap-payment-detail object is part of.


 
object
ap-payment-line object that this ap-payment-detail object is part of.


 
object
 
object
 
object
 
object
 
object
AP advance record.


 
object
AP advance line item record.


 
Array of objects
Array of payment lines in the payment.


 
 Array 
description
string or null
Memo or brief description of the AP payment line item.


 
 Example:  "Penalty"
object
 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "financialEntity": {
    • "id": "BOA"
    },
  • "paymentDate": "2023-04-04",
  • "action": "draft",
  • "description": "description",
  • "documentNumber": "123",
  • "documentId": "123",
  • "paymentRequestMethod": "useVendorPreference",
  • "baseCurrency": {
    • "currency": "USD"
    },
  • "txnCurrency": {
    • "currency": "USD"
    },
  • "paymentMethod": "creditCard",
  • "vendor": {
    • "id": "201"
    },
  • "details": [
    • {
      • "txnCurrency": {
        },
      • "bill": {
        },
      • "apDebitAdjustment": {
        },
      • "apDebitAdjustmentLine": {
        },
      • "apAdvance": {
        },
      • "apAdvanceLine": {
        },
      • "inlineBill": {
        },
      • "inlineBillLine": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3323",
    • "key": "3323",
    • "href": "/objects/accounts-payable/payment/3323"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a payment
get/objects/accounts-payable/payment/{key}
Returns detailed information for a specified payment.


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


 
 Example:  3323
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3302",
    • "key": "3302",
    • "paymentSummary": {
      • "id": "1843",
      • "key": "1843",
      • "name": "Payments: 2023/03/30 04:08:58:5637 Batch",
      • "postingDate": "2023-03-21",
      • "href": "/objects/accounts-payable/summary/1843"
      },
    • "recordType": "pp",
    • "financialEntity": {
      • "id": "BOA"
      },
    • "state": "submitted",
    • "paymentMethod": "creditCard",
    • "vendor": {
      • "entity": "V201",
      • "id": "201",
      • "name": "PG & E"
      },
    • "documentNumber": "123",
    • "description": "Payment for 2023-03-21",
    • "documentId": "Paid For PrjUS_InvWParent_4",
    • "txnDate": "2023-03-21",
    • "txnPaidDate": "2023-03-21",
    • "baseCurrency": {
      • "currency": "USD",
      • "totalAmount": "10.00",
      • "totalSelected": "0.00",
      • "totalPaid": "10.00",
      • "totalDue": "0.00"
      },
    • "txnCurrency": {
      • "currency": "USD",
      • "totalAmount": "10.00",
      • "totalSelected": "0.00",
      • "totalPaid": "10.00",
      • "totalDue": "0.00"
      },
    • "exchangeRate": {
      • "date": null,
      • "typeId": null,
      • "rate": null
      },
    • "payTo": {
      • "id": "PG & E(V201)",
      • "key": "6886",
      • "href": "/objects/company-config/contact/6886"
      },
    • "audit": {
      • "createdDateTime": "2023-03-29T18:08:57Z",
      • "modifiedDateTime": "2023-03-29T18:08:59Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "cleared": false,
    • "clearedDate": null,
    • "isInclusiveTax": false,
    • "taxSolution": {
      • "key": null,
      • "id": null,
      • "taxCalculationMethod": null
      },
    • "paymentRequestMethod": "useVendorPreference",
    • "jointPayee": {
      • "id": null,
      • "key": null
      },
    • "lines": [
      • {
        }
      ],
    • "details": [
      • {
        }
      ],
    • "href": "/objects/accounts-payable/payment/3302"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a payment
patch/objects/accounts-payable/payment/{key}
Updates an existing payment by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  3323
Request Body schema: application/json
object
Financial account from which the reconciliation is done.


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


 
 Example:  "BOA"
action
string
 Default:  "draft"
The action to take when the payment is created or updated.


    

  • submit - Submit or post the payment, depending on the approval workflow
    • 

  • draft - Move the payment to the outbox in the system
    • 



 Enum: "draft" "submit"  
 Example:  "submit"
documentNumber
string or null
Reference number for the payment, which can be the check number or the transaction number, depending on the payment method used.


 
 Example:  "3086"
description
string or null
Description of the payment (memo).


 
 Example:  "From billing through August 31"
documentId
string or null
Document ID for the payment.


 
 Example:  "Prim-Vendor-Invoice-VI#0008#doc"
paymentDate
string <date> 
The date to make the payment.


 
 Example:  "2021-01-23"
object
Transaction totals in base currency.


 
currency
string
The company's base currency.


 
 Example:  "USD"
object
Transaction totals in the currency in which it was paid.


 
currency
string
The currency in which the payment was made.


 
 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"
typeId
string or null
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
paymentMethod
string
Payment method for the payment.


 Enum: "ach" "cash" "creditCard" "eft" "jointCheck" "manualCheck" "onlineAchDebit" "onlineChargeCard" "printedCheck"  
 Example:  "printedCheck"
object
Vendor to receive the payment.


 
key
string
System-assigned key of the vendor.


 
 Example:  "201"
id
string
ID of the vendor.


 
 Example:  "V-00014"
paymentRequestMethod
string
 Default:  "useVendorPreference"
Determines how request are generated.
If the PAYMENTMETHOD value is "jointCheck" then the PAYMENTREQUESTMETHOD value must be "bill"


 Enum: "generateOneRequestPerBill" "mergeRequestIntoOnePerVendorPayToContact" "mergeRequestsIntoOnePerVendor" "useVendorPreference"  
 Example:  "generateOneRequestPerBill"
Array of objects  non-empty 
Array of details for the payment, including transaction payment amounts, line items, discounts, adjustments, and so forth.


 
 Array (non-empty)
object
Detail amounts in the company's base currency.


 
object
Detail amounts in the transaction currency.


 
discountDate
string or null <date> 
Discount date.


 
 Example:  "2023-04-04"
object
AP adjustment to pay.


 
object
Line item in the AP adjustment.


 
object
AP bill to pay.


 
object
Line item in the AP bill.


 
object
ap-payment object that this ap-payment-detail object is part of.


 
object
ap-payment-line object that this ap-payment-detail object is part of.


 
object
 
object
 
object
 
object
 
object
AP advance record.


 
object
AP advance line item record.


 
Array of objects
Array of payment lines in the payment.


 
 Array 
description
string or null
Memo or brief description of the AP payment line item.


 
 Example:  "Penalty"
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Payment for DOC Number: 22345",
  • "paymentDate": "2023-04-05",
  • "documentNumber": "22345",
  • "documentId": "22345"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3325",
    • "key": "3325",
    • "href": "/objects/accounts-payable/payment/3325"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a payment
delete/objects/accounts-payable/payment/{key}
Deletes a payment.


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


 
 Example:  3323
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
    }
}
Query payments
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-payable/payment"
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
    }
}