Payment details

A payment detail object can specify either an object, like an invoice or an adjustment, as a whole (header level), or it can specify a line item. A payment detail object also provides the transaction amount that was received.

Create and maintain AR payment details from the owning payment object.

List payment details

get/objects/accounts-receivable/payment-detail

Returns a collection with a key, ID, and link for each payment detail object. 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": "117",
      • "id": "117",
      • "href": "/objects/accounts-receivable/payment-detail/117"
      },
    • {
      • "key": "118",
      • "id": "118",
      • "href": "/objects/accounts-receivable/payment-detail/118"
      },
    • {
      • "key": "119",
      • "id": "119",
      • "href": "/objects/accounts-receivable/payment-detail/119"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 101,
    • "previous": null
    }
}
Get payment details
get/objects/accounts-receivable/payment-detail/{key}
Returns detailed information for a specified payment detail object.


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


 
 Example:  119
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "117",
    • "key": "117",
    • "arInvoice": {
      • "id": "426",
      • "key": "426",
      • "href": "/objects/accounts-receivable/invoice/426"
      },
    • "arInvoiceLine": {
      • "id": "929",
      • "key": "929",
      • "href": "/objects/accounts-receivable/invoice-line/929"
      },
    • "positiveAdjustment": {
      • "key": null,
      • "id": null
      },
    • "positiveAdjustmentLine": {
      • "id": null,
      • "key": null
      },
    • "inlineTxn": {
      • "key": "428",
      • "id": "428",
      • "href": "/objects/accounts-receivable/invoice/428"
      },
    • "inlineTxnLine": {
      • "id": "933",
      • "key": "933",
      • "href": "/objects/accounts-receivable/invoice-line/933"
      },
    • "arAdvance": {
      • "key": null,
      • "id": null
      },
    • "arAdvanceLine": {
      • "id": null,
      • "key": null
      },
    • "postedAdvance": {
      • "key": null,
      • "id": null
      },
    • "postedAdvanceLine": {
      • "id": null,
      • "key": null
      },
    • "arPostedOverPayment": {
      • "key": null,
      • "id": null
      },
    • "arPostedOverPaymentLine": {
      • "id": null,
      • "key": null
      },
    • "postedOverPayment": {
      • "key": null,
      • "id": null
      },
    • "postedOverPaymentLine": {
      • "id": null,
      • "key": null
      },
    • "negativeInvoice": {
      • "key": null,
      • "id": null
      },
    • "negativeInvoiceLine": {
      • "id": null,
      • "key": null
      },
    • "arAdjustment": {
      • "key": null,
      • "id": null
      },
    • "arAdjustmentLine": {
      • "id": null,
      • "key": null
      },
    • "arPayment": {
      • "id": "433",
      • "key": "433",
      • "href": "/objects/accounts-receivable/payment/433"
      },
    • "arPaymentLine": {
      • "id": "1011",
      • "key": "1011",
      • "href": "/objects/accounts-receivable/payment-line/1011"
      },
    • "paymentDate": "2024-11-25",
    • "baseCurrency": {
      • "paymentAmount": "5.00",
      • "inlineAmount": "10.00",
      • "postedAdvanceAmount": null,
      • "postedOverPaymentAmount": null,
      • "negativeInvoiceAmount": null,
      • "adjustmentAmount": null
      },
    • "txnCurrency": {
      • "inlineAmount": "10.00",
      • "postedAdvanceAmount": null,
      • "postedOverPaymentAmount": null,
      • "negativeInvoiceAmount": null,
      • "adjustmentAmount": null,
      • "paymentAmount": "50.00",
      • "currency": "USD"
      },
    • "discountDate": null,
    • "audit": {
      • "createdDateTime": "2024-11-25T07:09:13Z",
      • "modifiedDateTime": "2024-11-25T07:09:13Z",
      • "createdByUser": {
        },
      • "createdBy": "39",
      • "modifiedByUser": {
        },
      • "modifiedBy": "39"
      },
    • "href": "/objects/accounts-receivable/payment-detail/117"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}