Create External Audit API

Create External Audit API

Description

For the requested External audit, uploads the audit results matching the External System Audit Id.

Security

Logged in user has API > Audit> Create External Audit permissions

API Version

Argos API V6

URL

POST http://{{serverLocation}}/api/v{api-version}/audits/createexternalaudit

Parameters        

Model

Field
Type
Description
externalSystemStockAuditIdStringThe external audit systems audit ID
stockAuditCode
String
The stock auditor code
auditDate
Date
The date audit was done
notes
String
Note specific to the audit
Items
Items
Details of the audited items

Items

FieldTypeDescription
accountCodeStringThe bailment account code
sightedBooleanTrue if the item was sighted
reasonString (optional)Reason why the item was not sighted eg SOT
soldOutOfTrust
Boolean
True if the item was sold out of trust
value
Decimal
The item value
itemNotes
String
Notes about the specific item
terminateAccount
Boolean
True, if eligible for termination and you want to terminate the account

Example

Notes

{                                                                                                                                         
"externalSystemStockAuditId": "string",
"stockAuditorCode": "string",
"auditDate": "2024-07-30T01:21:03.692Z",
"notes": "string",
"items": [
      {
      "accountCode": "string",
      "sighted": true,
      "reason": "string",
      "soldOutOfTrust": true,
      "value": 0,
      "itemNotes": "string",
      "terminateAccount": true
      }
]
} 

Response

Model

FieldTypeDescription
SuccessBooleanTrue, if the audit result was successfully create, false otherwise
errorMessage
String (optional)
Details the error if success is false, null otherwise
auditId
String
The audit Id used to create the audit request

Example

Notes
{                    
  "success": true,
  "errorMessage": "string",
  "auditId": "string"                                                                                                                    
} 

Error Codes

HTTP Status Code
Type
200
OK (Success)
400
Bad request
​
Dealer not found or Auditor not found (error will be detailed in response)
401
Unauthorised (not Authenticated)
403
Forbidden (invalid Authorisation)
503
Service Unavailable (due to maintenance)


    • Related Articles

    • Request External Audit API

      Description Creates a new audit request for a Bailment dealer with External System Audit Id. Security Logged in user has API > Audit> Create External Audit permissions API Version Argos API V6 URL POST ...

    • Get Stock Audit Report Data API

      Description Get stock audit checklist report data columns required by external audit systems Security Logged in user has stock audit API permissions API Version Argos API V6 URL GET ...

    • External Stock Audit API Setup

      Purpose To allow users to send files directly from within Argos Bailment via an API Connection Access Bailment | Setup | External Stock Audit API Setup Dialog Details This dialog must be competed before any API Transfers can take place You may ...

    • 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 ...

    • Argos Vault Release Notes V5.144

      Release Completion Date: 17/05/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 the ...