Payment lines

Payment line items represent entries in a payment object. AP payment line is an owned object of AP payment.

List payment lines

get/objects/accounts-payable/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": "3936",
      • "id": "3936",
      • "href": "/objects/accounts-payable/payment-line/3936"
      },
    • {
      • "key": "3938",
      • "id": "3938",
      • "href": "/objects/accounts-payable/payment-line/3938"
      },
    • {
      • "key": "3940",
      • "id": "3940",
      • "href": "/objects/accounts-payable/payment-line/3940"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 0,
    • "pageSize": 1,
    • "next": 0,
    • "previous": null
    }
}
Get a payment line
get/objects/accounts-payable/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:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3936",
    • "key": "3936",
    • "apPayment": {
      • "id": "267",
      • "key": "267",
      • "href": "/objects/accounts-payable/payment/267"
      },
    • "glAccount": {
      • "key": "109",
      • "id": "2000",
      • "name": "Accounts Payable",
      • "href": "/objects/general-ledger/account/109"
      },
    • "baseCurrency": {
      • "amount": "100.00",
      • "currency": "USD",
      • "totalPaid": "0.00",
      • "totalSelected": "100.00"
      },
    • "txnCurrency": {
      • "amount": "100",
      • "currency": "USD",
      • "totalPaid": "0.00",
      • "totalSelected": "100.00"
      },
    • "dimensions": {
      • "department": {
        },
      • "location": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "project": {
        },
      • "class": {
        }
      },
    • "description": "Invoice for development in March 2024",
    • "exchangeRate": {
      • "date": "2024-07-21",
      • "typeId": null,
      • "rate": "1"
      },
    • "lineNumber": "1",
    • "paymentLineRecord": "pp",
    • "baseLocation": "1",
    • "audit": {
      • "createdDateTime": "2024-07-21T10:00:13Z",
      • "modifiedDateTime": "2024-07-21T10:00:13Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "taxDetail": {
      • "id": null,
      • "key": null
      },
    • "isTax": false,
    • "href": "/objects/accounts-payable/payment-line/3936"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}