Reserve Credit API

Description

Reserves credit for a future order

Security

Available for distributor users

URL

POST http://exampleserver.com/api/v4/orders/reservecredit

Parameters        

Model

Field	Type	Description
bailmentDealerCode	String	The bailment dealer code
amount	Number	Amount of credit to Reserve (GST Exclusive)
description	String	Optional description for the order
CheckForExistingOrder	Boolean	If the field is set to true, then if description is given along with the dealer code and a order with matching description is found The order approval number of the existing order is returned If not specified the default is false Added in V3

Example

{                                                                                                                                         

 "bailmentDealerCode": "string",

 "amount": 0,

 "description": "string",

 "checkForExistingOrder": "false"

}

Response

Model

Field	Type	Description
success	Boolean	True, if the credit was successfully reserved, false otherwise
errorMessage	String (optional)	Details the error if success is false, null otherwise
documentNumber	String (optional)	The Bailment order number created for this order, null if unsuccessful
orderStatus	String (optional)	The order status. Can either be Approved or Referred

Note: Response has an additional datapoint added. Upgrade to v4 version may require consumers to do updates at their end. Following this change, in http://exampleserver.com/api/v5/invoices/createinvoice, referred orders will generate an error until approved. 

Message: "Approval Pending, invoice has not been processed"

Example

{                                                                                                                                         

"success": true,

"errorMessage": "string",

"documentNumber": "string",

"orderStatus": "string"

} 

Error Codes

HTTP Status Code	Type
400	Invalid Request (error will be detailed in response)
403	Forbidden (invalid Authorisation) Credit suspended – Message: "Dealer credit suspended, order has not been processed" Insufficient Credit - Message:"Order total exceeds available credit, order has not been processed"
404	Dealer not found
503	Service Unavailable (due to maintenance)

Online Documentation

http://api.argos.co.nz/webapi/swagger/ui/index#!/Orders/Orders_ReserveCredit

• Related Articles

• Argos Vault Release Notes V5.146

  Release Completion Date: 30 August 2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in ...

• Bailment Order Processing

  Orders may be manually entered or imported through the API process. The value of the order is net of GST. It will quarantine the amount of credit to the value of the order. An order may be for one or multiple assets. When processed through the API an ...

• Bailment Order Details

  Purpose Allows manual entry or modification of orders. Access Bailment | View | Bailment Orders | Bailment Order Browse | or Dialog Details Details Specific Fields Field Explanation Approval Code Unique code assigned to an order Used to match against ...

• Argos API/EDI Import Tool

  This document outlines how to use the Argos API Import tool to import new Bailment Accounts from an external file through the Argos API Server. Also how raise Credit Returns and Price Adjustments. Prerequisites API Server The API Import tool requires ...

• Bailment Order Browse

  Purpose Allows for searching of orders. An order or group of orders may be cancelled. Access Bailment | View | Bailment Orders | Bailment Order Browse Search Criteria Browse Specific Search Criteria Field Explanation Status Select from the following ...