payables

Get a List of Payables

Returns a list of all payees for the specified Broker.

Securityx-api-key
Request
header Parameters
broker-id
required
integer (broker_id)

The id of the broker

Example: 66305
Responses
200

Example response

get/payables
Request samples 
Response samples 
application/json
{
  • "amount": 123.45,
  • "carrier_payee": {
    },
  • "created_datetime": "2023-10-26T00:00:00+00:00",
  • "eta": "2023-10-27T13:00:00+00:00",
  • "id": 87346,
  • "idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4",
  • "invoice_number": "355da12b-774b-41fc-9124-92d5f5a795ed",
  • "payee": {
    },
  • "payment_method": "ACH_NEXT_DAY",
  • "po_number": "AP12345",
  • "scheduled_for_date": "2023-10-29T00:00:00+00:00",
  • "status": "PENDING",
  • "updated_datetime": "2023-10-26T00:00:00+00:00"
}
Create a Payable
Create a Payable. A Payable is an amount owed to a creditor with a scheduled date for a payment to be initiated.


Securityx-api-key 
Request 
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Request Body schema: application/json
payee_id
integer (payee_id) 
The unique identifier of the Payee who will receive the funds. It could be a Carrier or a Factoring Company.


 
carrier_payee_id
integer (id) 
The id number of the object being returned.


 
payment_method
any (payment_method) 
The method used to settle a payable.


 Enum: "ACH_NEXT_DAY" "WALLET_ACH_NEXT_DAY" "PAPER_CHECK"  
amount
string (amount) 
Money in USD to transfer or has been transferred.


 
scheduled_for_date
string <date>  (scheduled_for_date) 
A valid date in the future when the payment should be initiated or "now" indicating immediate payment.


 
invoice_number
string (invoice_number) 
The invoice number being paid by the payable/receivable. This is visible by the Payee in remittance emails as reference_id.


 
po_number
string (po_number) 
A unique identifier that links the purchase order the payable.


 
idempotency_key
integer (idempotency_key) 
Provide a unique value to prevent duplicates during retries.


 
Responses 
200
Example response


post/payables
Request samples 
application/json
{
  • "payee_id": 896876,
  • "carrier_payee_id": 87346,
  • "payment_method": "ACH_NEXT_DAY",
  • "amount": "18.32",
  • "scheduled_for_date": "2023-10-29T00:00:00+00:00",
  • "invoice_number": "355da12b-774b-41fc-9124-92d5f5a795ed",
  • "po_number": "AP12345",
  • "idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4"
}
Response samples 
application/json
{
  • "id": 87346
}
Get a Single Payable
Get payable info associated with the specified id.


Securityx-api-key 
Request 
path Parameters
id
required
integer (id) 
The id number of the object being returned.


 
 Example:  87346
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Responses 
200
Example response


401
Unauthorized


403
Forbidden


404
Not Found


get/payables/{id}
Request samples 
Response samples 
application/json
{
  • "amount": 123.45,
  • "carrier_payee": {
    },
  • "created_datetime": "2023-10-26T00:00:00+00:00",
  • "eta": "2023-10-27T13:00:00+00:00",
  • "id": 87346,
  • "idempotency_key": "bac613de-5j27-1347-ka1n-q3p6173jacj4",
  • "invoice_number": "355da12b-774b-41fc-9124-92d5f5a795ed",
  • "payee": {
    },
  • "payment_method": "ACH_NEXT_DAY",
  • "po_number": "AP12345",
  • "scheduled_for_date": "2023-10-29T00:00:00+00:00",
  • "status": "PENDING",
  • "updated_datetime": "2023-10-26T00:00:00+00:00"
}
Update a Single Payable
Edit a Payable if it’s not already processing or completed.


Securityx-api-key 
Request 
path Parameters
id
required
integer (id) 
The id number of the object being returned.


 
 Example:  87346
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Request Body schema: application/json
Fields that can be updated


amount
string (amount) 
Money in USD to transfer or has been transferred.


 
invoice_number
string (invoice_number) 
The invoice number being paid by the payable/receivable. This is visible by the Payee in remittance emails as reference_id.


 
po_number
string (po_number) 
A unique identifier that links the purchase order the payable.


 
payee_id
integer (payee_id) 
The unique identifier of the Payee who will receive the funds. It could be a Carrier or a Factoring Company.


 
carrier_payee_id
integer (id) 
The id number of the object being returned.


 
scheduled_for_date
string <date>  (scheduled_for_date) 
A valid date in the future when the payment should be initiated or "now" indicating immediate payment.


 
payment_method
string or null (payment_method) 
The method used to settle a payable.


 Enum: "ACH_NEXT_DAY" "WALLET_ACH_NEXT_DAY" "PAPER_CHECK"  
Responses 
201
Example response


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


patch/payables/{id}
Request samples 
application/json
{
  • "amount": "18.32",
  • "invoice_number": "355da12b-774b-41fc-9124-92d5f5a795ed",
  • "po_number": "AP12345",
  • "payee_id": 896876,
  • "carrier_payee_id": 87346,
  • "scheduled_for_date": "2023-10-29T00:00:00+00:00",
  • "payment_method": "ACH_NEXT_DAY"
}
Response samples 
application/json
{
  • "id": 87346
}
Delete a Single Payable
Delete a Payable if it’s not already processing or completed.


Securityx-api-key 
Request 
path Parameters
id
required
integer (id) 
The id number of the object being returned.


 
 Example:  87346
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


delete/payables/{id}
Request samples 
Copyright © RoadSync 2023. All right reserved.