Tuhund - Register Expense Claim API

API List

CRM Integration API

Delivery / Shipment Order API

Expense Claims Integration API

Inventory Module Integration API

Sales Module Integration API

Shopping Cart Integration API

Procurement Module API

Manufacturing Module API

API # : 8024 | API Name : registerclaim

This API is used to register an expense claim from a person (Employee, Agent or any other person) or a business entity (Customer, Vendor or any other company) for reimbursement.

URL : <domain>/apic/registerclaim
Methods Allowed : POST

Please Note :

In case parent information is sent in the payload, system will not check if the parent exists or not. System allows you to register a claim even before registering the parent entity. Therefore, if the parent ID is wrong, system will assume that you are registering claim against an entity that will be registered later. In such a case, i.e when the parent entity is registered later, system will auto-link the existing claim that was registered against such an entity, earlier.

Payload Schema :

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "branchid": {
      "type": "string"
    },
    "claimerp": {
      "type": "string"
    },
    "parent": {
      "type": "string"
    },
    "claimdate": {
      "type": "string"
    },
    "createdby": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "exchange": {
      "type": "string"
    },
    "parenttype": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "summary": {
              "type": "string"
            },
            "accountid": {
              "type": "string"
            },
            "amount": {
              "type": "number"
            },
            "field1": {
              "type": "string"
            },
            "todate": {
              "type": "string"
            },
            "readingstart": {
              "type": "number"
            },
            "claimtypeid": {
              "type": "string"
            },
            "field3": {
              "type": "string"
            },
            "billno": {
              "type": "string"
            },
            "field2": {
              "type": "string"
            },
            "fromdate": {
              "type": "string"
            },
            "readingend": {
              "type": "integer"
            }
          },
          "required": [
            "summary",
            "accountid",
            "amount",
            "field1",
            "todate",
            "readingstart",
            "claimtypeid",
            "field3",
            "billno",
            "field2",
            "fromdate",
            "readingend"
          ]
        },
        {
          "type": "object",
          "properties": {
            "summary": {
              "type": "string"
            },
            "accountid": {
              "type": "string"
            },
            "amount": {
              "type": "number"
            },
            "field1": {
              "type": "string"
            },
            "todate": {
              "type": "string"
            },
            "readingstart": {
              "type": "number"
            },
            "claimtypeid": {
              "type": "string"
            },
            "field3": {
              "type": "string"
            },
            "billno": {
              "type": "string"
            },
            "field2": {
              "type": "string"
            },
            "fromdate": {
              "type": "string"
            },
            "readingend": {
              "type": "number"
            }
          },
          "required": [
            "summary",            
            "amount",            
            "claimtypeid",            
            "fromdate"
          ]
        }
      ]
    },
    "parentid": {
      "type": "string"
    }
  },
  "required": [
    "branchid",
    "claimerp",   
    "createdby"
  ]
}

Request Headers :

Name	Description
device	A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted.
Authentication	Authentication code generated for API call.

Sample Payload :

{
  "branchid": "ENTERPRISE",
  "claimerp": "ytQhxW",
  "parent": "Event",
  "claimdate": "17/03/2022",
  "createdby": "ytQhxW",
  "currency": "USD",
  "exchange": "74.565",
  "parenttype": "EVENT",
  "items": [
    {
      "summary": "Travel by cab to client office",
      "amount": 98.5,
      "field1": "Head Office",
      "todate": "01/03/2022 10:30",
      "claimtypeid": "nc8qqb",
      "field3": "Taxi",
      "billno": "B5655",
      "field2": "Client office",
      "fromdate": "01/03/2022 09:30"
    },
    {
      "summary": "Return by cab from client office",
      "amount": 98.5,
      "field1": "Client office",
      "todate": "01/03/2022 18:30",
      "claimtypeid": "nc8qqb",
      "field3": "Taxi",
      "billno": "B5655",
      "field2": "Head Office",
      "fromdate": "01/03/2022 17:30"
    }
  ],
  "parentid": "3A2nYP"
}

Sample success response :

{
  "result": 1,
  "claimid": "1650179993635"
}

Sample failure response :

Case 1: Mandatory Field(s) Missing

{ "response": -1, "errors": [ { "param": "claimerp/claimerc", "error": "claimerp (Claimer as a person) / claimerc (Claimer as a company) is a mandatory key.Any one of the two is required." }, { "param": "createdby", "error": "Created by ID is a mandatory key" } ] }