Payment lines

Line items in an AR payment represent charges for items or services included in an invoice or adjustment.

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

List payment lines

get/objects/accounts-receivable/payment-line

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


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


 
 Example:  28
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "1369",
    • "key": "1369",
    • "arPayment": {
      • "key": "121",
      • "id": "121",
      • "href": "/objects/accounts-receivable/payment/121"
      },
    • "glAccount": {
      • "key": "263",
      • "id": "1103",
      • "name": "Accounts Receivable - Microcomputer",
      • "href": "/objects/general-ledger/account/263"
      },
    • "dimensions": {
      • "department": {
        },
      • "location": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "employee": {
        },
      • "contract": {
        },
      • "project": {
        },
      • "class": {
        }
      },
    • "memo": "null,",
    • "exchangeRate": {
      • "date": "2024-04-15",
      • "typeId": "-1",
      • "rate": 1
      },
    • "baseCurrency": {
      • "amount": "100",
      • "currency": "USD",
      • "totalPaid": "0",
      • "totalSelected": "100"
      },
    • "txnCurrency": {
      • "amount": "100",
      • "currency": "USD",
      • "totalPaid": "0",
      • "totalSelected": "100"
      },
    • "lineNumber": 1,
    • "offsetGLAccount": {
      • "key": "9",
      • "href": "/objects/general-ledger/account/9"
      },
    • "audit": {
      • "createdDateTime": "2024-04-21T12:34:02Z",
      • "modifiedDateTime": "2024-07-04T08:18:29Z",
      • "createdByUser": {
        },
      • "createdBy": "39",
      • "modifiedByUser": {
        },
      • "modifiedBy": "39"
      },
    • "href": "/objects/accounts-receivable/payment-line/1369"
    }
}