GET Claims/GetClaimBasicById/{id}

Gets a single Claim, by its Id.


Parameters

NameDescriptionAdditional information
id
The Id of the item to get.

Define this parameter in the request URI.

Response body formats

A ClaimResponse, containing the Claim if found.

application/json, text/json

Sample:
{
  "Item": {
    "EmployeeId": 1,
    "ClaimId": 2,
    "ClaimNumber": 3,
    "ClaimName": "sample string 4",
    "Description": "sample string 5",
    "EmployeeName": "sample string 6",
    "BaseCurrency": 7,
    "Stage": 8,
    "TotalStageCount": 9,
    "ClaimStage": 1,
    "Status": 0,
    "Approved": true,
    "Submitted": true,
    "CheckerId": 1,
    "ItemCheckerId": 1,
    "DisplayDeclaration": true,
    "ReferenceNumber": "sample string 13",
    "CurrencySymbol": "sample string 14",
    "CurrencyLabel": "sample string 15",
    "AmountPayable": 16.0,
    "Total": 17.0,
    "DisplayOneClickSignoff": true,
    "NumberOfItems": 19,
    "DateSubmitted": "2025-01-26T07:08:04.5142325+00:00",
    "DatePaid": "2025-01-26T07:08:04.5142325+00:00",
    "ClaimBasicOutcome": 0,
    "ClaimEnvelopeInfo": [
      {
        "ClaimEnvelopeId": 1,
        "EnvelopeNumber": "sample string 2",
        "<PhysicalState>k__BackingField": "sample string 1",
        "<ExcessCharge>k__BackingField": "sample string 2",
        "<ProcessedAfterMarkedLost>k__BackingField": "sample string 3"
      },
      {
        "ClaimEnvelopeId": 1,
        "EnvelopeNumber": "sample string 2",
        "<PhysicalState>k__BackingField": "sample string 1",
        "<ExcessCharge>k__BackingField": "sample string 2",
        "<ProcessedAfterMarkedLost>k__BackingField": "sample string 3"
      },
      {
        "ClaimEnvelopeId": 1,
        "EnvelopeNumber": "sample string 2",
        "<PhysicalState>k__BackingField": "sample string 1",
        "<ExcessCharge>k__BackingField": "sample string 2",
        "<ProcessedAfterMarkedLost>k__BackingField": "sample string 3"
      }
    ],
    "CurrentApprover": "sample string 20",
    "Claimant": "sample string 21",
    "CanBeUnassigned": true
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ClaimBasicItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:AmountPayable>16</d2p1:AmountPayable>
    <d2p1:Approved>true</d2p1:Approved>
    <d2p1:BaseCurrency>7</d2p1:BaseCurrency>
    <d2p1:CanBeUnassigned>true</d2p1:CanBeUnassigned>
    <d2p1:CheckerId>1</d2p1:CheckerId>
    <d2p1:ClaimBasicOutcome>SingleClaimOnly</d2p1:ClaimBasicOutcome>
    <d2p1:ClaimEnvelopeInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/SpendManagementLibrary">
      <d3p1:ClaimEnvelopeInfo>
        <d3p1:ClaimEnvelopeId>1</d3p1:ClaimEnvelopeId>
        <d3p1:EnvelopeNumber>sample string 2</d3p1:EnvelopeNumber>
        <d3p1:_x003C_ExcessCharge_x003E_k__BackingField>sample string 2</d3p1:_x003C_ExcessCharge_x003E_k__BackingField>
        <d3p1:_x003C_PhysicalState_x003E_k__BackingField>sample string 1</d3p1:_x003C_PhysicalState_x003E_k__BackingField>
        <d3p1:_x003C_ProcessedAfterMarkedLost_x003E_k__BackingField>sample string 3</d3p1:_x003C_ProcessedAfterMarkedLost_x003E_k__BackingField>
      </d3p1:ClaimEnvelopeInfo>
      <d3p1:ClaimEnvelopeInfo>
        <d3p1:ClaimEnvelopeId>1</d3p1:ClaimEnvelopeId>
        <d3p1:EnvelopeNumber>sample string 2</d3p1:EnvelopeNumber>
        <d3p1:_x003C_ExcessCharge_x003E_k__BackingField>sample string 2</d3p1:_x003C_ExcessCharge_x003E_k__BackingField>
        <d3p1:_x003C_PhysicalState_x003E_k__BackingField>sample string 1</d3p1:_x003C_PhysicalState_x003E_k__BackingField>
        <d3p1:_x003C_ProcessedAfterMarkedLost_x003E_k__BackingField>sample string 3</d3p1:_x003C_ProcessedAfterMarkedLost_x003E_k__BackingField>
      </d3p1:ClaimEnvelopeInfo>
      <d3p1:ClaimEnvelopeInfo>
        <d3p1:ClaimEnvelopeId>1</d3p1:ClaimEnvelopeId>
        <d3p1:EnvelopeNumber>sample string 2</d3p1:EnvelopeNumber>
        <d3p1:_x003C_ExcessCharge_x003E_k__BackingField>sample string 2</d3p1:_x003C_ExcessCharge_x003E_k__BackingField>
        <d3p1:_x003C_PhysicalState_x003E_k__BackingField>sample string 1</d3p1:_x003C_PhysicalState_x003E_k__BackingField>
        <d3p1:_x003C_ProcessedAfterMarkedLost_x003E_k__BackingField>sample string 3</d3p1:_x003C_ProcessedAfterMarkedLost_x003E_k__BackingField>
      </d3p1:ClaimEnvelopeInfo>
    </d2p1:ClaimEnvelopeInfo>
    <d2p1:ClaimId>2</d2p1:ClaimId>
    <d2p1:ClaimName>sample string 4</d2p1:ClaimName>
    <d2p1:ClaimNumber>3</d2p1:ClaimNumber>
    <d2p1:ClaimStage>Current</d2p1:ClaimStage>
    <d2p1:Claimant>sample string 21</d2p1:Claimant>
    <d2p1:CurrencyLabel>sample string 15</d2p1:CurrencyLabel>
    <d2p1:CurrencySymbol>sample string 14</d2p1:CurrencySymbol>
    <d2p1:CurrentApprover>sample string 20</d2p1:CurrentApprover>
    <d2p1:DatePaid>2025-01-26T07:08:04.5142325+00:00</d2p1:DatePaid>
    <d2p1:DateSubmitted>2025-01-26T07:08:04.5142325+00:00</d2p1:DateSubmitted>
    <d2p1:Description>sample string 5</d2p1:Description>
    <d2p1:DisplayDeclaration>true</d2p1:DisplayDeclaration>
    <d2p1:DisplayOneClickSignoff>true</d2p1:DisplayOneClickSignoff>
    <d2p1:EmployeeId>1</d2p1:EmployeeId>
    <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
    <d2p1:ItemCheckerId>1</d2p1:ItemCheckerId>
    <d2p1:NumberOfItems>19</d2p1:NumberOfItems>
    <d2p1:ReferenceNumber>sample string 13</d2p1:ReferenceNumber>
    <d2p1:Stage>8</d2p1:Stage>
    <d2p1:Status>None</d2p1:Status>
    <d2p1:Submitted>true</d2p1:Submitted>
    <d2p1:Total>17</d2p1:Total>
    <d2p1:TotalStageCount>9</d2p1:TotalStageCount>
  </Item>
</ClaimBasicItemResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body