Payment details

A payment detail object includes a bill or adjustment credit memo to pay and optional transactions to apply as credits. AP payment detail is an owned object of AP payment.

List payment details

get/objects/accounts-payable/payment-detail

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

201

Created

400

Bad Request

401

Unauthorized

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "367",
      • "id": "367",
      • "href": "/objects/accounts-payable/payment-detail/367"
      },
    • {
      • "key": "1043",
      • "id": "1043",
      • "href": "/objects/accounts-payable/payment-detail/1043"
      },
    • {
      • "key": "1203",
      • "id": "1203",
      • "href": "/objects/accounts-payable/payment-detail/1203"
      }
    ],
  • "ia::meta": {
    • "totalCount": 509,
    • "start": 1,
    • "pageSize": 100,
    • "next": 101,
    • "previous": null
    }
}
Get payment details
get/objects/accounts-payable/payment-detail/{key}
Returns detailed information for a specified payment detail object.


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


 
 Example:  29
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "1133",
    • "key": "1133",
    • "bill": {
      • "id": "2570",
      • "key": "2570",
      • "href": "/objects/accounts-payable/bill/2570"
      },
    • "billLine": {
      • "id": "25392",
      • "key": "25392",
      • "href": "/objects/accounts-payable/bill-line/25392"
      },
    • "apCreditAdjustment": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/adjustment/25394"
      },
    • "apCreditAdjustmentLine": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/adjustment-line/25394"
      },
    • "apPayment": {
      • "id": "3346",
      • "key": "3346",
      • "href": "/objects/accounts-payable/payment/3346"
      },
    • "apPaymentLine": {
      • "id": "31060",
      • "key": "31060",
      • "href": "/objects/accounts-payable/payment-line/31060"
      },
    • "paymentDate": "2023-04-12",
    • "baseCurrency": {
      • "paymentAmount": "100.00",
      • "inlineAmount": null,
      • "discountAmount": null,
      • "adjustmentAmount": null,
      • "postedAdvanceAmount": null
      },
    • "txnCurrency": {
      • "paymentAmount": "100.00",
      • "inlineAmount": "10.00",
      • "discountAmount": "10.00",
      • "adjustmentAmount": "10.00",
      • "postedAdvanceAmount": "10.00",
      • "currency": "USD"
      },
    • "inlineBill": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/bill/25394"
      },
    • "inlineBillLine": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/bill-line/25394"
      },
    • "discountDate": "2023-04-12",
    • "apDebitAdjustment": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/adjustment/25394"
      },
    • "apDebitAdjustmentLine": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/adjustment-line/25394"
      },
    • "apAdvance": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/advance/25394"
      },
    • "apAdvanceLine": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/advance-line/25394"
      },
    • "apPostedAdvance": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/advance/25394"
      },
    • "apPostedAdvanceLine": {
      • "id": "25394",
      • "key": "25394",
      • "href": "/objects/accounts-payable/advance-line/25394"
      },
    • "state": "confirmed",
    • "moduleKey": "3.AP",
    • "audit": {
      • "createdDateTime": "2023-04-12T07:05:13Z",
      • "modifiedDateTime": "2023-04-12T07:05:13Z",
      • "createdBy": "71",
      • "modifiedBy": "71"
      },
    • "jointPayee": {
      • "id": null,
      • "key": null,
      • "printAs": null
      },
    • "href": "/objects/accounts-payable/payment-detail/1133"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query payment details
post/services/core/query
Use the query service to find payment details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples