/get-bbc-data/

Purpose
Retrieve the BBC for a given day.
Return Information
Variable Name Type Purpose
BBCdate date The date of the requested BBC.
ClientDetails JSON[] JSON Array of Client Data with the following properties:
Variable Name Type Purpose
ClientName String The Name of the Client
CompCode String A unique identifier for a specific client.
ClientIndustry String Options in FactorCloud will be Transportation, Construction, Staffing, General
ClientLocationState String State Code
ClientLocationCountry String Country
ClientType String Factoring or Future ABL
CollateralType String Accounts Receivable
AR0to30 Float Open AR Amount 0 - 30
AR31to60 Float Open AR Amount 31 - 60
AR61to90 Float Open AR Amount 61 - 90
AROVER90 Float Open AR Amount > 90
TotalAR Float Total AR based on Open Loads
LedgeredAR Float Total AR on Ledger - should match TotalAR - check against
Difference Float Difference between ledger vs. open ar
IneligiblePastDueAR Float AR Passed invoice terms on client
IneligibleOverCreditAR Float Any AR past client ineligible days
StandardPercentER Float The standard Escrow Reserve percent per invoice for the client.
NFEvalue Float The Factoring Net Funds Employed
CreditLimit Float Client Credit Limit
ClientPaymentTerms integer Contracted Days to Pay
UCCExpire Date UCC expiration Date
ARPrevDayBalance Float The previous day's account receivables
ARChangeCurrentDay Float The current day's change in accounts receivables
ARAdjustmentsPos Float The current day's purchased and onboarded AR
ARAdjustmentsNeg Float The current day's charged back and negative AR adjustments
ARPayments Float The current day's incoming payments that reduce AR
ARNewBalance Float The AR at the end of the passed date. Also the sum of (ARPrevDayBalance + ARChangeCurrentDay) as well
as the sum of (ARPrevDayBalance + ARAdjustmentsPos + ARAdjustmentsNeg + ARPayments)
NFEPrevDayBalance Float The previous day's Factoring Net Funds Employed
NFEChangeCurrentDay Float The current day's change in factoring NFE
NFEAdjustmentsPos Float The current day's purchased, onboarded, overadvanced, reserve released, etc ... Factoring NFE additions
NFEAdjustmentsNeg Float The current day's charged back, Held Cash, manual adjustments, and additional negative factoring NFE adjustments
NFELoanPayments Float The current day's incoming payments that reduce factoring NFE
NFENewBalance Float The factoring NFE at the end of the passed date. Also the sum of (NFEPrevDayBalance + NFEChangeCurrentDay)
as well as the sum of (NFEPrevDayBalance + NFEAdjustmentsPos + NFEAdjustmentsNeg + NFELoanPayments)
Liabilities Float Purchased Invoices where advances have not yet gone out. Issued releases where money has not been send.
PurchaseFees Float The discount at schedule purchase.
NewLoanBalance Float The factoring NFE - Liabilities - PurchaseFees
UnnappliedTotalAmount float ???
UnappliedTotalTransactions integer ???
UnappliedLedgerDetails JSON[] JSON Array of unapplied ledger details with the following properties:
Variable Name Type Purpose
PaymentDate String ???
BankAccount String ???
Description String ???
UnappliedAmount String ???
PaymenType String ???
BatchId String ???
RefNumber String ???
RemitterAccount String ???
RemitterName String ???
Client String ???
Expected Return
An echo JSON object with the above fields.
Example cURL Call
curl --keepalive-time 3000 -m 3000 -H "Auth-FactorId: FACTORID" -H "Auth-SystemKey: SYSTEMKEY" -H "Auth-ApiKey: APIKEY" -H "Auth-AdminKey: ADMINKEY" "https://wstest.factorcloud.com/api_factor/get-bbc-data/?BBCdate=2021-05-01"
Example Path
{
   https://wstest.factorcloud.com/api_factor/get-bbc-data/?BBCdate=2021-05-01
}
Example Return
    {
        "BBCDate": "2021-05-02",
        "ClientDetails": [
          {
            "ClientName": "AA Transport",
            "CompCode": "AA",
            "ClientIndustry": "Transportation",
            "ClientLocationState": "GA",
            "ClientLocationCountry": "USA",
            "ClientType": "Factoring",
            "CollateralType": "Accounts Receivable",
            "AR0to30": "1000.00",
            "AR31to60": "0",
            "AR61to90": "0",
            "AROVER90": "0",
            "TotalAR": "1000.00",
            "LedgeredAR": "1000.00",
            "Difference": "0.00",
            "IneligiblePastDueAR": "0.00",
            "IneligibleOverCreditAR": "0.00",
            "StandardPercentER": "5.00",
            "NFEvalue": "950.00",
            "CreditLimit": "1000000.00",
            "ClientPaymentTerms": "30",
            "UCCExpire": "2021-04-29T00:00:00Z",
            "ARPrevDayBalance": "1000.00",
            "ARChangeCurrentDay": "0.00",
            "ARAdjustmentsPos": "0.00",
            "ARAdjustmentsNeg": "0.00",
            "ARPayments": "0.00",
            "ARNewBalance": "1000.00",
            "NFEPrevDayBalance": "950.00",
            "NFEChangeCurrentDay": "0.00",
            "NFEAdjustmentsPos": "0.00",
            "NFEAdjustmentsNeg": "0.00",
            "NFELoanPayments": "0.00",
            "NFENewBalance": "950.00",
            "Liabilities": "0.00",
            "PurchaseFees": "0.00",
            "NewLoanBalance": "950.00"
          },
          {
            "ClientName": "FF Client",
            "CompCode": "FF",
            "ClientIndustry": "Transportation",
            "ClientLocationState": "GA",
            "ClientLocationCountry": "USA",
            "ClientType": "Factoring",
            "CollateralType": "Accounts Receivable",
            "AR0to30": "1000.00",
            "AR31to60": "0",
            "AR61to90": "0",
            "AROVER90": "0",
            "TotalAR": "1000.00",
            "LedgeredAR": "1000.00",
            "Difference": "0.00",
            "IneligiblePastDueAR": "0.00",
            "IneligibleOverCreditAR": "0.00",
            "StandardPercentER": "3.00",
            "NFEvalue": "1434.76",
            "CreditLimit": "10000000.00",
            "ClientPaymentTerms": "30",
            "UCCExpire": "2021-04-27T00:00:00Z",
            "ARPrevDayBalance": "1000.00",
            "ARChangeCurrentDay": "0.00",
            "ARAdjustmentsPos": "0.00",
            "ARAdjustmentsNeg": "0.00",
            "ARPayments": "0.00",
            "ARNewBalance": "1000.00",
            "NFEPrevDayBalance": "1434.76",
            "NFEChangeCurrentDay": "0.00",
            "NFEAdjustmentsPos": "0.00",
            "NFEAdjustmentsNeg": "0.00",
            "NFELoanPayments": "0.00",
            "NFENewBalance": "1434.76",
            "Liabilities": "0.00",
            "PurchaseFees": "0.00",
            "NewLoanBalance": "1434.76"
          },
          {
            "ClientName": "Generic Broker",
            "CompCode": "GB",
            "ClientIndustry": "Transportation",
            "ClientLocationState": "AL",
            "ClientLocationCountry": "USA",
            "ClientType": "Factoring",
            "CollateralType": "Accounts Receivable",
            "AR0to30": "1000.00",
            "AR31to60": "0",
            "AR61to90": "0",
            "AROVER90": "0",
            "TotalAR": "1000.00",
            "LedgeredAR": "1000.00",
            "Difference": "0.00",
            "IneligiblePastDueAR": "0.00",
            "IneligibleOverCreditAR": "0.00",
            "StandardPercentER": "5.00",
            "NFEvalue": "920.00",
            "CreditLimit": "210000.00",
            "ClientPaymentTerms": "30",
            "UCCExpire": "2021-04-26T00:00:00Z",
            "ARPrevDayBalance": "1000.00",
            "ARChangeCurrentDay": "0.00",
            "ARAdjustmentsPos": "0.00",
            "ARAdjustmentsNeg": "0.00",
            "ARPayments": "0.00",
            "ARNewBalance": "1000.00",
            "NFEPrevDayBalance": "920.00",
            "NFEChangeCurrentDay": "0.00",
            "NFEAdjustmentsPos": "0.00",
            "NFEAdjustmentsNeg": "0.00",
            "NFELoanPayments": "0.00",
            "NFENewBalance": "920.00",
            "Liabilities": "-947.00",
            "PurchaseFees": "0.00",
            "NewLoanBalance": "-27.00"
          },
          {
            "ClientName": "Generic Transport",
            "CompCode": "GTRANS",
            "ClientIndustry": "Transportation",
            "ClientLocationState": "GA",
            "ClientLocationCountry": "USA",
            "ClientType": "Factoring",
            "CollateralType": "Accounts Receivable",
            "AR0to30": "1400.00",
            "AR31to60": "0",
            "AR61to90": "0",
            "AROVER90": "0",
            "TotalAR": "1400.00",
            "LedgeredAR": "1400.00",
            "Difference": "0.00",
            "IneligiblePastDueAR": "0.00",
            "IneligibleOverCreditAR": "0.00",
            "StandardPercentER": "5.00",
            "NFEvalue": "1297.00",
            "CreditLimit": "1000000.00",
            "ClientPaymentTerms": "30",
            "UCCExpire": "2021-04-23T00:00:00Z",
            "ARPrevDayBalance": "1400.00",
            "ARChangeCurrentDay": "0.00",
            "ARAdjustmentsPos": "0.00",
            "ARAdjustmentsNeg": "0.00",
            "ARPayments": "0.00",
            "ARNewBalance": "1400.00",
            "NFEPrevDayBalance": "1297.00",
            "NFEChangeCurrentDay": "0.00",
            "NFEAdjustmentsPos": "0.00",
            "NFEAdjustmentsNeg": "0.00",
            "NFELoanPayments": "0.00",
            "NFENewBalance": "1297.00",
            "Liabilities": "-2365.00",
            "PurchaseFees": "0.00",
            "NewLoanBalance": "-1068.00"
          }
        ],
        "UnnappliedTotalAmount": "18434.00",
        "UnappliedTotalTransactions": "8",
        "UnappliedLedgerDetails": [
          {
            "PaymentDate": "2021-04-26T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "1003",
            "UnappliedAmount": "100.00",
            "PaymenType": "ACH",
            "BatchId": "87088",
            "RefNumber": "2.60E+13",
            "RemitterAccount": "1331004541",
            "RemitterName": "Debtor",
            "Client": "Generic Broker"
          },
          {
            "PaymentDate": "2021-04-26T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "",
            "UnappliedAmount": "900.00",
            "PaymenType": "ACH",
            "BatchId": "87091",
            "RefNumber": "111",
            "RemitterAccount": "",
            "RemitterName": "111",
            "Client": "Generic Broker"
          },
          {
            "PaymentDate": "2021-04-27T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "",
            "UnappliedAmount": "100.00",
            "PaymenType": "ACH",
            "BatchId": "87092",
            "RefNumber": "1122",
            "RemitterAccount": "",
            "RemitterName": "",
            "Client": "Generic Transport"
          },
          {
            "PaymentDate": "2021-04-27T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "",
            "UnappliedAmount": "100.00",
            "PaymenType": "ACH",
            "BatchId": "87093",
            "RefNumber": "aaa",
            "RemitterAccount": "",
            "RemitterName": "aaa",
            "Client": "Generic Transport"
          },
          {
            "PaymentDate": "2021-04-27T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "",
            "UnappliedAmount": "1234.00",
            "PaymenType": "ACH",
            "BatchId": "87094",
            "RefNumber": "1234",
            "RemitterAccount": "",
            "RemitterName": "",
            "Client": ""
          },
          {
            "PaymentDate": "2021-04-27T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "",
            "UnappliedAmount": "15000.00",
            "PaymenType": "ACH",
            "BatchId": "87095",
            "RefNumber": "4567",
            "RemitterAccount": "",
            "RemitterName": "",
            "Client": ""
          },
          {
            "PaymentDate": "2021-04-27T00:00:00Z",
            "BankAccount": "Lockbox",
            "Description": "",
            "UnappliedAmount": "900.00",
            "PaymenType": "ACH",
            "BatchId": "87093",
            "RefNumber": "aaa",
            "RemitterAccount": "",
            "RemitterName": "aaa",
            "Client": "FF Client"
          }
        ]
      }
Sample Error Response(s) 
{"message":"401 Unauthorized"}
{"message":"400 Bad Request Invalid BBCdate"}
Return to Index