Skip to main content

Last non payment for orders

· One min read
Joe Longstreet

Two new fields are now available on the /order endpoints: lastNonPaymentDate and lastNonPaymentReason. Both fields are nullable dependent on whether a not the associated order has a lastNonPaymentReason. A last non payment reason can be any one of the following values:

DISCREPANCY_IN_PRICING_OF_PRODUCTS_RECEIVED
DISCREPANCY_IN_QUALITY_OR_NATURE_OF_PRODUCTS_RECEIVED
INSOLVENCY_RISK
INSUFFICIENT_FUNDS
ORDER_NEVER_RECEIVED
PICKUP_UNALIGNED_WITH_RETAILER_ACCOUNTING_PRACTICES
REPRESENTATIVE_CANNOT_FACILITATE_PAYMENT
RETAILER_ALLEGES_TO_HAVE_ALREADY_PAID_INVOICE_TO_BRAND
RETAILER_ALLEGES_TO_HAVE_ALREADY_PAID_INVOICE_TO_NABIS

Example excerpt from response​

{
  "lastNonPaymentDate": "2024-03-04T21:42:17.871Z",
  "lastNonPaymentReason": "DISCREPANCY_IN_PRICING_OF_PRODUCTS_RECEIVED"
}

Filtering orders by whether or not a last non payment reason exists is possible with the lastNonPaymentReason query parameter. To retrieve only orders which have a last non payment reason, use lastNonPaymentReason=true. To retrieve only orders which do not have a last non payment reason, use lastNonPaymentReason=false.

Filtering orders by a lastNonPaymentDate is now also possible. To retrieve only orders with a last non payment reason between January 1st 2024 and January 30th 2024, use startLastNonPaymentDate=2024-01-01&endLastNonPaymentDate=2024-01-30. This will automatically apply the lastNonPaymentReason filter, ensuring all returned orders have a last non payment.

View the Order API Reference (get many) for more detail.