Joint payees

The joint payee object tracks AP bills and joint payees to allow for joint check payments. Construction subscription is needed. See Joint check basics in the Sage Intacct Help Center for more information.

List joint payees

get/objects/accounts-payable/joint-payee

Returns a collection with a key, ID, and link for each joint payee.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/accounts-payable/joint-payee/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/accounts-payable/joint-payee/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/accounts-payable/joint-payee/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a joint payee
post/objects/accounts-payable/joint-payee
Creates a new joint payee.


SecurityOAuth2 
Request 
Request Body schema: application/json
name
required
string
Name of the joint payee. The name value cannot be changed after a payment has been made using the printAs field.


 
 Example:  "John Smith"
printAs
required
string
Name that will print on the check. Usually, this value is the vendor's pay-to contact name and the joint payee name.
This value must be unique per bill. This value cannot be changed after a payment has been made.


 
 Example:  "Orchard Supply Hardware & John Smith"
required
object
The bill associated with this joint payee.


 
key
string
Unique key for the bill.


 
 Example:  "1"
id
string
Unique ID for the bill.


 
 Example:  "INV-1285"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "John Smith",
  • "printAs": "Orchard Supply Hardware & John Smith",
  • "bill": {
    • "key": "1"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "3",
    • "href": "/objects/accounts-payable/joint-payee/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a joint payee
get/objects/acounts-payable/joint-payee/{key}
Returns detailed information for a specified joint payee.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the joint payee.


 
 Example:  80
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "3",
    • "key": "3",
    • "name": "John Smith",
    • "printAs": "Orchard Supply Hardware & John Smith",
    • "bill": {
      • "key": "1",
      • "id": "INV1258",
      • "href": "/objects/accounts-payable/bill/1"
      },
    • "href": "/objects/accounts-payable/joint-payee/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a joint payee
patch/objects/acounts-payable/joint-payee/{key}
Updates an existing joint payee by setting field values. Any fields not provided remain unchanged. The printAs value cannot be updated if it has been used on an AP Payment.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the joint payee.


 
 Example:  80
Request Body schema: application/json
name
string
Name of the joint payee. The name value cannot be changed after a payment has been made using the printAs field.


 
 Example:  "John Smith"
printAs
string
Name that will print on the check. Usually, this value is the vendor's pay-to contact name and the joint payee name.
This value must be unique per bill. This value cannot be changed after a payment has been made.


 
 Example:  "Orchard Supply Hardware & John Smith"
object
The bill associated with this joint payee.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "printAs": "Orchard Wholesale Co. & John Smith Jr."
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "3",
    • "href": "/objects/accounts-payable/joint-payee/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a joint payee
delete/objects/acounts-payable/joint-payee/{key}
Deletes a joint payee. A joint payee object cannot be deleted if it has been used on an AP payment.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the joint payee.


 
 Example:  80
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 joint payees
post/services/core/query
Use the query service to find joint payees that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples