The Certify API

The Certify API is a RESTful API that enables you to build applications and integrations that interact directly with data in Certify. Make calls directly to our API endpoints without having to login and access the data manually.

All production API requests are made to:

https://api.certify.com/v1/

REST

The Certify API uses standard RESTful API calls via HTTP web requests with methods like GET, POST, and DELETE. All calls must be made using HTTPS.

JSON and XML

The Certify API accepts requests and returns responses in either JSON or XML. Please set the Content-Type header to either “application/json” or “application/xml” in the requests to define which format you would like. The default format is JSON.

Authentication

All API calls to the Certify API must include authentication information to verify the identity of the caller. Authentication is comprised of two tokens called the API Key and the API Secret. The API Key is a hashed code for your company; it tells us who you are. The API Secret is a generated token that grants you access to your Certify data. Both tokens can be found in the Configuration section of your company’s administrator users inside Certify. These tokens should NOT be freely given out, they should only be given to parties trusted with access to your company’s data.

To properly provide authentication, each API call must have the following headers:

Header Name Header Value
x-api-key API Key
x-api-secret API Secret

Responses

Successful responses returned from the Certify API will be formatted according to the specific API method called. Any errors returned will be in the following format:

JSON
{
  errorCode: {code}
  errorValue: {value}
}

XML
<Error>
    <ErrorCode>{code}</ErrorCode>
    <ErrorMessage>{message}</ErrorMessage>
</Error>

Refer to the list of general error codes or the documentation for the specific API method called for more information.

Code Description
400 Bad Request. Method request is incorrectly formatted.
401 Unauthorized. Authentication failed. API Key or API Secret is invalid or not provided in the request.
403 maximum response record limit exceeded or invalid method endpoint.
405 Method Not Allowed. Request contains an HTTP method type that is not supported for that API function.
500 Internal Server Error. Contact Certify for further assistance.

Note: There is a maximum limit of 10,000 records returned. If the request returns more than the limit, it must be narrowed down using the filter parameters of the method.

API Methods Expand All   |  Collapse All

GET
/cpdlists
Expand Method
Description

This method will return a list of one or more custom per-diem lists for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
name query Name of custom per-diem list No string
active query Active status No string (1 for active records, 0 for inactive, NULL for all)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "CPDLists": [
        {
            "ID": "82480202-c661-4afe-b36d-c8d97865a339",
            "Name": "Corproate Sales",
            "Description": "New list specifically for Corp Sales",
            "Data": "",
            "Active": 1
        },
        {
            "ID": "9ea702a7-fe30-412c-81e5-ff4d04ead3ab",
            "Name": "Sales",
            "Description": "",
            "Data": "",
            "Active": 0
        }
    ]
}

<CPDLists>
    <CPDList>
        <ID>82480202-c661-4afe-b36d-c8d97865a339</ID>
        <Name>Corproate Sales</Name>
        <Description>New list specifically for Corp Sales</Description>
        <Data />
        <Active>1</Active>
    </CPDList>
</CPDLists>
Field Value Description
ID Unique ID of the custom per-diem list.
Name Custom per-diem list name.
Description The internal description for the custom per-diem list.
Data Used to store various internal code values for the custom per-diem list.
Active The active status of the custom per-diem list (1 = active, 0 = inactive)
GET
/cpdlists/{id}
Expand Method
Description

This method should return a custom per-diem list associated with the supplied ID value, returning the same elements as the GET /cpdlists method.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Custom per-diem list ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "CPDLists": [
        {
            "ID": "82480202-c661-4afe-b36d-c8d97865a339",
            "Name": "Corproate Sales",
            "Description": "New list specifically for Corp Sales",
            "Data": "",
            "Active": 1
        }
    ]
}

<CPDLists>
    <CPDList>
        <ID>82480202-c661-4afe-b36d-c8d97865a339</ID>
        <Name>Corproate Sales</Name>
        <Description>New list specifically for Corp Sales</Description>
        <Data />
        <Active>1</Active>
    </CPDList>
</CPDLists>
Field Value Description
ID Unique ID of the custom per-diem list.
Name Custom per-diem list name.
Description The internal description for the custom per-diem list.
Data Used to store various internal code values for the custom per-diem list.
Active The active status of the custom per-diem list (1 = active, 0 = inactive)
GET
/departments
Expand Method
Description

This method returns a list of one or more departments for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
name query Name of department No string
code query Department code No string
active query Active status No string (1 for active records, 0 for inactive, NULL for all)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "Departments": [
        {
            "ID": "c456ab38-8f74-49e2-a47b-178f72c2f45f",
            "Name": "General",
            "Code": "01",
            "Description": "",
            "Data": "",
            "ObtainSecondLevelApproval": 0,
            "UseStrictFiltering": 0,
            "HideDepartment": 0,
            "HideBillable": 0,
            "HideBillableDefaultValue": 0,
            "HideReimbursable": 0,
            "HideReimbursableDefaultValue": 1,
            "InitialPage": 0,
            "LastModifiedDate": "2017-8-10",
            "Active": 1
        },
        {
            "ID": "75f84785-2c62-491d-a6d2-aa220a0e33dc",
            "Name": "Product Dev",
            "Code": "01",
            "Description": "",
            "Data": "",
            "ObtainSecondLevelApproval": 1,
            "UseStrictFiltering": 0,
            "HideDepartment": 0,
            "HideBillable": 0,
            "HideBillableDefaultValue": 0,
            "HideReimbursable": 0,
            "HideReimbursableDefaultValue": 1,
            "InitialPage": 0,
            "LastModifiedDate": "2018-7-21",
            "Active": 1
        }
    ]
}

<Departments>
    <Department>
        <ID>c456ab38-8f74-49e2-a47b-178f72c2f45f</ID>
        <Name>General</Name>
        <Code>01</Code>
        <Description />
        <Data />
        <ObtainSecondLevelApproval>0</ObtainSecondLevelApproval>
        <UseStrictFiltering>0</UseStrictFiltering>
        <HideDepartment>0</HideDepartment>
        <HideBillable>0</HideBillable>
        <HideBillableDefaultValue>0</HideBillableDefaultValue>
        <HideReimbursable>0</HideReimbursable>
        <HideReimbursableDefaultValue>1</HideReimbursableDefaultValue>
        <InitialPage>0</InitialPage>
        <LastModifiedDate>2017-8-10</LastModifiedDate>
        <Active>1</Active>
    </Department>
    <Department>
        <ID>75f84785-2c62-491d-a6d2-aa220a0e33dc</ID>
        <Name>Product Dev</Name>
        <Code>01</Code>
        <Description />
        <Data />
        <ObtainSecondLevelApproval>1</ObtainSecondLevelApproval>
        <UseStrictFiltering>0</UseStrictFiltering>
        <HideDepartment>0</HideDepartment>
        <HideBillable>0</HideBillable>
        <HideBillableDefaultValue>0</HideBillableDefaultValue>
        <HideReimbursable>0</HideReimbursable>
        <HideReimbursableDefaultValue>1</HideReimbursableDefaultValue>
        <InitialPage>0</InitialPage>
        <LastModifiedDate>2018-7-21</LastModifiedDate>
        <Active>1</Active>
    </Department>
</Departments>
Field Value Description
ID Unique ID of the department.
Name Department name.
Code The internal code used to identify the department in your organization.
Description The internal description for the department
Data Used to store various internal code values for the department.
ObtainSecondLevelApproval Indicates that second level approval is required for all expenses in this department (1 = yes, 0 = no)
UseStrictFiltering Indicates that this department will only display those expense categories linked with it (1 = yes, 0 = no)
HideDepartment Indicates thats users in this department don't need to select a department (1 = yes, 0 = no)
HideBillable Indicates that users in this department always select either billable or non-billable expenses (1 = yes, 0 = no)
HideBillableDefaultValue Indicates the default billable value to use for this department (1 = billable, 0 = non-billable)
HideReimbursable Indicates that users in this department always select either reimbursable or non-reimbursable expenses (1 = yes, 0 = no)
HideReimbursableDefaultValue Indicates the default reimbursable value to use for this department (1 = reimbursable, 0 = non-reimbursable)
InitialPage Indicates the initial page presented to users in this department upon login (Home = 0, CertifyTravel = 1, NewExpenseReport = 2, MyDraftExpenseReports = 3, MyApprovalRequests = 4, MyProcessingRequests = 5, MyCertifyWallet = 6, MyInquiries = 7)
LastModifiedDate Date the department was last update (YYYY-MM-DD)
Active The active status of the department (1 = active, 0 = inactive)
POST
/departments
Expand Method
Description

For each department element in the POST body, this method will update department records for the user’s company corresponding to the IDs supplied. Any elements where new values were not provided will retain their current value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
ID body Department ID Yes string
Name body Department name No string
Code body The internal code used to identify the department in your organization. No string
Description body The internal description for the department. No string
ObtainSecondLevelApproval body Indicates that second level approval is required for all expenses in this department (1 = yes, 0 = no) No string
UseStrictFiltering body Indicates that this department will only display those expense categories linked with it (1 = yes, 0 = no) No string
HideDepartment body Indicates that users in this department don’t need to select a department (1 = yes, 0 = no) No string
HideBillable body Indicates that users in this department always select either billable or non-billable expenses (1 = yes, 0 = no) No string
HideBillableDefaultValue body Indicates the default billable value to use for this department (1 = billable, 0 = non-billable) No string
HideReimbursable body Indicates that users in this department always select either reimbursable or non-reimbursable expenses (1 = yes, 0 = no) No string
HideReimbursableDefaultValue body Indicates the default reimbursable value to use for this department (1 = reimbursable, 0 = non-reimbursable) No string
InitialPage body Indicates the initial page presented to users in this department upon login (Home = 0, CertifyTravel = 1, NewExpenseReport = 2, MyDraftExpenseReports = 3, MyApprovalRequests = 4, MyProcessingRequests = 5, MyCertifyWallet = 6, MyInquiries = 7) No string
Active body The active status of the department (1 = active, 0 = inactive) No string
Example Request
JSON XML 
[
  {
    "ID": "49c6743a-2f4c-4bb4-8092-ab724c92baf2",
    "Name": "Test Department",
    "Code": "01",
    "Description" : "Updated description 1",
    "ObtainSecondLevelApproval": 0,
    "UseStrictFiltering": 0,
    "HideDepartment": 0,
    "HideBillable": 0,
    "HideBillableDefaultValue": 0,
    "HideReimbursable" : 1,
    "HideReimbursableDefaultValue" : 1,
    "InitialPage" : 1
  },
  {
    "ID": "49c6743a-2f4c-4bb4-8092-ab724c92baf2",
    "Description" : "Updated description 2",
    "ObtainSecondLevelApproval": 0,
    "UseStrictFiltering": 0,
    "HideDepartment": 0,
    "HideBillable": 0,
    "HideBillableDefaultValue": 0,
    "HideReimbursable" : 1,
    "HideReimbursableDefaultValue" : 0,
    "InitialPage" : 2
  }
]

<Departments>
   <Department>
     <ID>49c6743a-2f4c-4bb4-8092-ab724c92baf2</ID>
     <Name>Test Department</Name>
     <Code>01</Code>
     <Description>Updated description 1</Description>
     <ObtainSecondLevelApproval>0</ObtainSecondLevelApproval>
     <UseStrictFiltering>0</UseStrictFiltering>
     <HideBillable>0</HideBillable>
     <HideBillableDefaultValue>0</HideBillableDefaultValue>
     <HideDepartment>0</HideDepartment>
     <HideReimbursable>1</HideReimbursable>
     <HideReimbursableDefaultValue>1</HideReimbursableDefaultValue>
     <InitialPage>1</InitialPage>
   </Department>
   <Department>
    <ID>49c6743a-2f4c-4bb4-8092-ab724c92baf2</ID>
     <Description>Updated description 2</Description>
     <ObtainSecondLevelApproval>0</ObtainSecondLevelApproval>
     <UseStrictFiltering>0</UseStrictFiltering>
     <HideBillable>0</HideBillable>
     <HideBillableDefaultValue>0</HideBillableDefaultValue>
     <HideDepartment>0</HideDepartment>
     <HideReimbursable>1</HideReimbursable>
     <HideReimbursableDefaultValue>0</HideReimbursableDefaultValue>
     <InitialPage>2</InitialPage>
   </Department>
</Departments>
Response

A separate status should be returned for each record, either "Updated" or "Error" with a detailed error message. HTTP Status should be 200.

Example Response
JSON XML 
[
    {
        "ID": "49c6743a-2f4c-4bb4-8092-ab724c92baf2",
        "Status": "Updated",
        "Message": ""
    },
    {
        "ID": "49c6743a-2f4c-fb4-8092-ab724c92baf2",
        "Status": "Error",
        "Message": "Department ID is not a valid ID."
    }
]

<Results>
    <Result>
        <ID>49c6743a-2f4c-4bb4-8092-ab724c92baf2</ID>
        <Status>Updated</Status>
        <Message />
    </Result>
    <Result>
        <ID>49c6743a-2f4c-fb4-8092-ab724c92baf2</ID>
        <Status>Error</Status>
        <Message>Department ID is not a valid ID.</Message>
    </Result>
</Results>
Field Value Description
ID Unique ID of the department.
Status Returns status of "Updated" or "Error".
Message Detailed message when Status returns an "Error".
PUT
/departments
Expand Method
Description

This method creates a new department record for the user’s company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
Name body Department name No string
Code body The internal code used to identify the department in your organization. No string
Description body The internal description for the department. No string
ObtainSecondLevelApproval body Indicates that second level approval is required for all expenses in this department (1 = yes, 0 = no) No string
UseStrictFiltering body Indicates that this department will only display those expense categories linked with it (1 = yes, 0 = no) No string
HideDepartment body Indicates that users in this department don’t need to select a department (1 = yes, 0 = no) No string
HideBillable body Indicates that users in this department always select either billable or non-billable expenses (1 = yes, 0 = no) No string
HideBillableDefaultValue body Indicates the default billable value to use for this department (1 = billable, 0 = non-billable) No string
HideReimbursable body Indicates that users in this department always select either reimbursable or non-reimbursable expenses (1 = yes, 0 = no) No string
HideReimbursableDefaultValue body Indicates the default reimbursable value to use for this department (1 = reimbursable, 0 = non-reimbursable) No string
InitialPage body Indicates the initial page presented to users in this department upon login (Home = 0, CertifyTravel = 1, NewExpenseReport = 2, MyDraftExpenseReports = 3, MyApprovalRequests = 4, MyProcessingRequests = 5, MyCertifyWallet = 6, MyInquiries = 7) No string
Active body The active status of the department (1 = active, 0 = inactive) No string
Example Request
JSON XML 
{
    "Name": "Test Department",
    "Code": "01",
    "Description": "",
    "ObtainSecondLevelApproval": 0,
    "UseStrictFiltering": 0,
    "HideDepartment": 0,
    "HideBillable": 0,
    "HideBillableDefaultValue": 0,
    "HideReimbursable": 0,
    "HideReimbursableDefaultValue": 1,
    "InitialPage": 0
}

<Department>
   <Code>01</Code>
   <Description />
   <HideBillable>0</HideBillable>
   <HideBillableDefaultValue>0</HideBillableDefaultValue>
   <HideDepartment>0</HideDepartment>
   <HideReimbursable>0</HideReimbursable>
   <HideReimbursableDefaultValue>1</HideReimbursableDefaultValue>
   <InitialPage>0</InitialPage>
   <Name>Test Department</Name>
   <ObtainSecondLevelApproval>0</ObtainSecondLevelApproval>
   <UseStrictFiltering>0</UseStrictFiltering>
</Department>
Response

If successful, this method should return the ID of the new department.

Example Response
JSON XML 
{
    "ID": "9a61cf7f-0bf7-425e-bc62-d85c5db7c88d"
}

<ID>9a61cf7f-0bf7-425e-bc62-d85c5db7c88d</ID>
Field Value Description
ID Unique ID of the department.
GET
/departments/{id}
Expand Method
Description

This method returns a list of one or more departments for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Department ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "Department": [
        {
            "ID": "c456ab38-8f74-49e2-a47b-178f72c2f45f",
            "Name": "General",
            "Code": "01",
            "Description": "",
            "Data": "",
            "ObtainSecondLevelApproval": 0,
            "UseStrictFiltering": 0,
            "HideDepartment": 0,
            "HideBillable": 0,
            "HideBillableDefaultValue": 0,
            "HideReimbursable": 0,
            "HideReimbursableDefaultValue": 1,
            "InitialPage": 0,
            "LastModifiedDate": "2017-8-10",
            "Active": 1
        }
    ]
}


<Departments>
    <Department>
        <ID>c456ab38-8f74-49e2-a47b-178f72c2f45f</ID>
        <Name>General</Name>
        <Code>01</Code>
        <Description />
        <Data />
        <ObtainSecondLevelApproval>0</ObtainSecondLevelApproval>
        <UseStrictFiltering>0</UseStrictFiltering>
        <HideDepartment>0</HideDepartment>
        <HideBillable>0</HideBillable>
        <HideBillableDefaultValue>0</HideBillableDefaultValue>
        <HideReimbursable>0</HideReimbursable>
        <HideReimbursableDefaultValue>1</HideReimbursableDefaultValue>
        <InitialPage>0</InitialPage>
        <LastModifiedDate>2017-8-10</LastModifiedDate>
        <Active>1</Active>
    </Department>
</Departments>
-
Field Value Description
ID Unique ID of the department.
Name Department name.
Code The internal code used to identify the department in your organization.
Description The internal description for the department
Data Used to store various internal code values for the department.
ObtainSecondLevelApproval Indicates that second level approval is required for all expenses in this department (1 = yes, 0 = no)
UseStrictFiltering Indicates that this department will only display those expense categories linked with it (1 = yes, 0 = no)
HideDepartment Indicates thats users in this department don't need to select a department (1 = yes, 0 = no)
HideBillable Indicates that users in this department always select either billable or non-billable expenses (1 = yes, 0 = no)
HideBillableDefaultValue Indicates the default billable value to use for this department (1 = billable, 0 = non-billable)
HideReimbursable Indicates that users in this department always select either reimbursable or non-reimbursable expenses (1 = yes, 0 = no)
HideReimbursableDefaultValue Indicates the default reimbursable value to use for this department (1 = reimbursable, 0 = non-reimbursable)
InitialPage Indicates the initial page presented to users in this department upon login (Home = 0, CertifyTravel = 1, NewExpenseReport = 2, MyDraftExpenseReports = 3, MyApprovalRequests = 4, MyProcessingRequests = 5, MyCertifyWallet = 6, MyInquiries = 7)
LastModifiedDate Date the department was last update (YYYY-MM-DD)
Active The active status of the department (1 = active, 0 = inactive)
GET
/empglds/{index}
Expand Method
Description

This method will return a list of one or more employee GLD records for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Employee GLD index Yes number
name query Name of employee GLD No string
code query Employee GLD code No string
active query Active status No string (1 for active records, 0 for inactive, NULL for all)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "EmpGLDs": [
        {
            "EmpGLDIndex": 1,
            "EmpGLDLabel": "Favorite Food",
            "ID": "3ceef8d9-7284-462e-b54a-8238e737446a",
            "Name": "Chicken Wings",
            "Code": "",
            "Description": "",
            "Data": "",
            "Active": 1
        },
        {
            "EmpGLDIndex": 1,
            "EmpGLDLabel": "Favorite Food",
            "ID": "df3c742d-91ef-4843-9a87-59a9e9581fe9",
            "Name": "Nachos",
            "Code": "",
            "Description": "",
            "Data": "",
            "Active": 1
        }
    ]
}

<EmpGLDs>
    <EmpGLD>
        <EmpGLDIndex>1</EmpGLDIndex>
        <EmpGLDLabel>Favorite Food</EmpGLDLabel>
        <ID>3ceef8d9-7284-462e-b54a-8238e737446a</ID>
        <Name>Chicken Wings</Name>
        <Code />
        <Description />
        <Data />
        <Active>1</Active>
    </EmpGLD>
    <EmpGLD>
        <EmpGLDIndex>1</EmpGLDIndex>
        <EmpGLDLabel>Favorite Food</EmpGLDLabel>
        <ID>df3c742d-91ef-4843-9a87-59a9e9581fe9</ID>
        <Name>Nachos</Name>
        <Code />
        <Description />
        <Data />
        <Active>1</Active>
    </EmpGLD>
</EmpGLDs>
Field Value Description
EmpGLDIndex The index of the EmpGLD requested.
EmpGLDLabel The label assigned the EmpGLD by the client in Configuration.
ID Unique ID of the employee GLD.
Name Employee GLD name.
Code The internal code used to identify the employee GLD in your organization.
Description The internal description for the employee GLD.
Data Used to store various internal code values for the employee GLD
Active The active status of the employee GLD (1 = active, 0 = inactive)
POST
/empglds/{index}
Expand Method
Description

For each employee GLD element in the POST body, this method will update employee GLD records for the current company corresponding to the IDs supplied. Any elements where new values were not provided will retain their current value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Employee GLD index Yes number
ID body Employee GLD ID Yes string
Name body Employee GLD name No string
Code body The internal code used to identify the employee GLD in your organization. No string
Description body The internal description for the employee GLD. No string
Active body The active status of the employee GLD (1 = active, 0 = inactive) No string
Example Request
JSON XML 
[
    {
        "ID": "f4f76080-8003-4406-b4b4-f647bb40fa0d",
        "Description": "Meat and vegetarian"
    },
    {
        "ID": "6b2e73ba-af1c-467a-bc04-8ac13e22c423",
        "Code": "RTCHKDP",
        "Description": "with Corn Chips"
    }
]



<EmpGLDs>
    <EmpGLD>
        <ID>f4f76080-8003-4406-b4b4-f647bb40fa0d</ID>
        <Description>Meat and vegetarian</Description>
    </EmpGLD>
    <EmpGLD>
        <ID>6b2e73ba-af1c-467a-bc04-8ac13e22c423</ID>
        <Code>RTCHKDP</Code>
        <Description>with Corn Chips</Description>
    </EmpGLD>
</EmpGLDs>
Response

A separate status should be returned for each record, either "Updated" or "Error" with a detailed error message. HTTP Status should be 200.

Example Response
JSON XML 
[
    {
        "ID": "f4f76080-8003-4406-b4b4-f647bb40fa0d",
        "Status": "Updated",
        "Message": ""
    },
    {
        "ID": "6b2e73ba-af1c-467a-bc04-8ac13e22c423",
        "Status": "Error",
        "Message": "EmpGLD2 ID supplied is not valid."
    }
]

<Results>
    <Result>
        <ID>f4f76080-8003-4406-b4b4-f647bb40fa0d</ID>
        <Status>Updated</Status>
        <Message />
    </Result>
    <Result>
        <ID>6b2e73ba-af1c-467a-bc04-8ac13e22c423</ID>
        <Status>Error</Status>
        <Message>EmpGLD2 ID supplied is not valid.</Message>
    </Result>
</Results>
Field Value Description
ID Unique ID of the employee GLD.
Status Returns status of "Updated" or "Error".
Message Detailed message when Status returns an "Error".
PUT
/empglds/{index}
Expand Method
Description

This method creates a new employee GLD record for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Employee GLD index Yes number
Name body Employee GLD name Yes string
Code body The internal code used to identify the employee GLD in your organization. No string
Description body The internal description for the employee GLD. No string
Active body The active status of the employee GLD (1 = active, 0 = inactive) No string
Example Request
JSON XML 
{
    "Name": "Lasagna",
    "Code": "LSGN",
    "Description": "Meat or vegetarian",
    "Active": 1
}

<EmpGLD>
    <Name>Lasagna</Name>
    <Code>LSGN</Code>
    <Description>Meat or vegetarian</Description>
    <Active>1</Active>
</EmpGLD>
Response

If successful, this method should return the ID of the new employee GLD.

Example Response
JSON XML 
{
    "ID": "f4f76080-8003-4406-b4b4-f647bb40fa0d"
}

<ID>f4f76080-8003-4406-b4b4-f647bb40fa0d</ID>
Field Value Description
ID Unique ID of the employee GLD.
GET
/empglds/{index}/{id}
Expand Method
Description

This method returns an employee GLD record associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Employee GLD index Yes number
id path Employee GLD ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "EmpGLDs": [
        {
            "EmpGLDIndex": 1,
            "EmpGLDLabel": "Favorite Food",
            "ID": "3ceef8d9-7284-462e-b54a-8238e737446a",
            "Name": "Chicken Wings",
            "Code": "",
            "Description": "",
            "Data": "",
            "Active": 1
        }
    ]
}


<EmpGLDs>
    <EmpGLD>
        <EmpGLDIndex>1</EmpGLDIndex>
        <EmpGLDLabel>Favorite Food</EmpGLDLabel>
        <ID>3ceef8d9-7284-462e-b54a-8238e737446a</ID>
        <Name>Chicken Wings</Name>
        <Code />
        <Description />
        <Data />
        <Active>1</Active>
    </EmpGLD>
</EmpGLDs>
Field Value Description
EmpGLDIndex The index of the EmpGLD requested.
EmpGLDLabel The label assigned the EmpGLD by the client in Configuration.
ID Unique ID of the employee GLD.
Name Employee GLD name.
Code The internal code used to identify the employee GLD in your organization.
Description The internal description for the employee GLD.
Data Used to store various internal code values for the employee GLD
Active The active status of the employee GLD (1 = active, 0 = inactive)
GET
/expensecategories
Expand Method
Description

This method returns a list of one or more expense categories for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
name query Name of expense category No string
glcode query Expense category GL code No string
expensetypeid query The identifier for the expense type (1 = Cash Expense, 2 = Mileage, 3 = Lodging, 4 = Meals, 5 = Rentals, 6 = Travel, 7 = Per-Diem, 8 = Hourly, 9 = Invoice) No string
departmentfilterid query Associated Department ID No string
active query Active status No string (1 for active records, 0 for inactive)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response

A separate status should be returned for each record, either "Updated" or "Error" with a detailed error message. HTTP Status should be 200.

JSON XML 
{
    "ExpenseCategories": [
        {
            "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e",
            "Name": "Sales & Marketing:6032",
            "Description": "",
            "Data": "",
            "ExpenseTypeID": 1,
            "MaxAmount": 0,
            "MaxAmountCurrencyType": "USD",
            "GLCode": "6032",
            "FilterDepartmentID": "1a727dfe-4c9f-4108-ac0d-4fa5d512f83c",
            "PrepaidCode": "",
            "RequireReceiptOverride": 0,
            "RequireReceiptThresholdAmount": 0,
            "DetailedMealAttendees": 0,
            "PersonalExpenses": 0,
            "RequireReason": 1,
            "StrictFilteringException": 0,
            "SupressBillable": 0,
            "SupressBillableDefaultValue": 0,
            "DeductCommuteUnits": 0,
            "CashAdvances": 0,
            "DailyMealLimit": 0,
            "Active": 0,
            "UseNPI": 0,
            "RequireNPI": 0,
            "CPDBreakfast": 0,
            "CPDLunch": 0,
            "CPDDinner": 0,
            "CPDIncidentals": 0,
            "CPDLodging": 0,
            "CPDReimbursementMethodID": 0,
            "CPDListID": "",
            "UseGSA": 0,
            "GSABreakfast": 0,
            "GSALunch": 0,
            "GSADinner": 0,
            "GSAIncidentals": 0,
            "GSALodging": 0,
            "GSAReimbursementMethodID": 0
        },
        {
            "ID": "393ad8b8-a370-40c3-9252-60244fa7a6bf",
            "Name": "Accounting:6033",
            "Description": "",
            "Data": "",
            "ExpenseTypeID": 1,
            "MaxAmount": 100,
            "MaxAmountCurrencyType": "USD",
            "GLCode": "6033",
            "FilterDepartmentID": "1a727dfe-4c9f-4108-ac0d-4fa5d512f83c",
            "PrepaidCode": "",
            "RequireReceiptOverride": 0,
            "RequireReceiptThresholdAmount": 0,
            "DetailedMealAttendees": 0,
            "PersonalExpenses": 0,
            "RequireReason": 0,
            "StrictFilteringException": 0,
            "SupressBillable": 0,
            "SupressBillableDefaultValue": 0,
            "DeductCommuteUnits": 0,
            "CashAdvances": 0,
            "DailyMealLimit": 0,
            "Active": 0,
            "UseNPI": 0,
            "RequireNPI": 0,
            "CPDBreakfast": 0,
            "CPDLunch": 0,
            "CPDDinner": 0,
            "CPDIncidentals": 0,
            "CPDLodging": 1,
            "CPDReimbursementMethodID": 2,
            "CPDListID": "c2fd97b9-4a3e-4756-84b3-ebd81ddf7831",
            "UseGSA": 0,
            "GSABreakfast": 0,
            "GSALunch": 0,
            "GSADinner": 0,
            "GSAIncidentals": 0,
            "GSALodging": 0,
            "GSAReimbursementMethodID": 0
        }
    ]
}


<ExpenseCategories>
    <ExpenseCategory>
        <ID>9f903b49-64dc-45c8-8216-2928ed2b6b2e</ID>
        <Name>Sales & Marketing:6032</Name>
        <Description />
        <Data />
        <ExpenseTypeID>1</ExpenseTypeID>
        <MaxAmount>0.0000</MaxAmount>
        <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
        <GLCode>6032</GLCode>
        <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
        <PrepaidCode />
        <RequireReceiptOverride>0</RequireReceiptOverride>
        <RequireReceiptThresholdAmount>0.0000</RequireReceiptThresholdAmount>
        <DetailedMealAttendees>0</DetailedMealAttendees>
        <PersonalExpenses>0</PersonalExpenses>
        <RequireReason>1</RequireReason>
        <StrictFilteringException>0</StrictFilteringException>
        <SupressBillable>0</SupressBillable>
        <SupressBillableDefaultValue>0</SupressBillableDefaultValue>
        <DeductCommuteUnits>0</DeductCommuteUnits>
        <CashAdvances>0</CashAdvances>
        <DailyMealLimit>0</DailyMealLimit>
        <Active>0</Active>
        <UseNPI>0</UseNPI>
        <RequireNPI>0</RequireNPI>
        <CPDBreakfast>0</CPDBreakfast>
        <CPDLunch>0</CPDLunch>
        <CPDDinner>0</CPDDinner>
        <CPDIncidentals>0</CPDIncidentals>
        <CPDLodging>0</CPDLodging>
        <CPDReimbursementMethodID>0</CPDReimbursementMethodID>
        <CPDListID />
        <UseGSA>0</UseGSA>
        <GSABreakfast>0</GSABreakfast>
        <GSALunch>0</GSALunch>
        <GSADinner>0</GSADinner>
        <GSAIncidentals>0</GSAIncidentals>
        <GSALodging>0</GSALodging>
        <GSAReimbursementMethodID>0</GSAReimbursementMethodID>
    </ExpenseCategory>
    <ExpenseCategory>
        <ID>393ad8b8-a370-40c3-9252-60244fa7a6bf</ID>
        <Name>Sales & Marketing:6033</Name>
        <Description />
        <Data />
        <ExpenseTypeID>1</ExpenseTypeID>
        <MaxAmount>100.0000</MaxAmount>
        <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
        <GLCode>6033</GLCode>
        <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
        <PrepaidCode />
        <RequireReceiptOverride>0</RequireReceiptOverride>
        <RequireReceiptThresholdAmount>0.0000</RequireReceiptThresholdAmount>
        <DetailedMealAttendees>0</DetailedMealAttendees>
        <PersonalExpenses>0</PersonalExpenses>
        <RequireReason>0</RequireReason>
        <StrictFilteringException>0</StrictFilteringException>
        <SupressBillable>0</SupressBillable>
        <SupressBillableDefaultValue>0</SupressBillableDefaultValue>
        <DeductCommuteUnits>0</DeductCommuteUnits>
        <CashAdvances>0</CashAdvances>
        <DailyMealLimit>0</DailyMealLimit>
        <Active>0</Active>
        <UseNPI>0</UseNPI>
        <RequireNPI>0</RequireNPI>
        <CPDBreakfast>0</CPDBreakfast>
        <CPDLunch>0</CPDLunch>
        <CPDDinner>0</CPDDinner>
        <CPDIncidentals>0</CPDIncidentals>
        <CPDLodging>1</CPDLodging>
        <CPDReimbursementMethodID>2</CPDReimbursementMethodID>
        <CPDListID>c2fd97b9-4a3e-4756-84b3-ebd81ddf7831</CPDListID>
        <UseGSA>0</UseGSA>
        <GSABreakfast>0</GSABreakfast>
        <GSALunch>0</GSALunch>
        <GSADinner>0</GSADinner>
        <GSAIncidentals>0</GSAIncidentals>
        <GSALodging>0</GSALodging>
        <GSAReimbursementMethodID>0</GSAReimbursementMethodID>
    </ExpenseCategory>
</ExpenseCategories>
Field Value Description
ID The unique ID of the expense category.
Name The expense category name.
Description The internal description for the expense category.
Data Used to store various internal code values for the expense category.
ExpenseTypeID The expense type ID (1 = Cash Expense, 2 = Mileage, 3 = Lodging, 4 = Meals, 5 = Rentals, 6 = Travel, 7 = Per-Diem, 8 = Hourly, 9 = Invoice)
MaxAmount The maximum expense amount permitted for this expense category.
MaxAmountCurrencyType The currency code for the maximum amount (i.e. ‘GBP’, ‘USD’).
GLCode The general ledger code associated with this expense category.
FilterDepartmentID The ID of the department associated with this expense category.
PrepaidCode The prepaid code associated with this expense category (cash expense types only).
UseNPI Show Physician (companies using NPI only; 1 = true, 0 = false).
RequireNPI Require Physician (companies using NPI only; 1 = true, 0 = false).
RequireReceiptOverride Determines whether this category will use the standard receipt requirement threshold amount, or override it (0 = Inherit From Policy, 1 = Use Threshold Amount).
RequireReceiptThresholdAmount Sets the override threshold amount for this category.
DetailedMealAttendees Require detailed meal attendees (1 = true, 0 = false).
PersonalExpenses Designates the category as pertaining to personal expenses (1 = true, 0 = false).
RequireReason Require a reason for expenses in this category (1 = true, 0 = false).
CPDBreakfast Expense category used for CPD breakfast expenses (meal expense types for companies using CPD only; 1 = true, 0 = false).
CPDLunch Expense category used for CPD lunch expenses (meal expense types for companies using CPD only; 1 = true, 0 = false).
CPDDinner Expense category used for CPD dinner expenses (meal expense types for companies using CPD only; 1 = true, 0 = false).
CPDIncidentals Expense category used for CPD incidental expenses (cash expense types for companies using CPD only; 1 = true, 0 = false).
CPDLodging Expense category used for CPD lodging expenses (companies using CPD only; 1 = true, 0 = false).
CPDReimbursementMethodID CPD reimbursement method (companies using CPD only; 0 = Expense Amount Capped, 1 = CPD Amount, 2 = CPD Amount No Expense Amount).
CPDListID The unique ID of the Custom Per Diem List.
UseGSA Expense category uses GSA (companies using GSA only; 1 = true, 0 = false).
GSABreakfast Expense category used for GSA breakfast expenses (meal expense types for companies using GSA only; 1 = true, 0 = false).
GSALunch Expense category used for GSA lunch expenses (meal expense types for companies using GSA only; 1 = true, 0 = false).
GSADinner Expense category used for GSA dinner expenses (meal expense types for companies using GSA only; 1 = true, 0 = false).
GSAIncidentals Expense category used for GSA incidental expenses (cash expense types for companies using GSA only; 1 = true, 0 = false).
GSALodging Expense category used for GSA lodging expenses (companies using GSA only; 1 = true, 0 = false).
GSAReimbursementMethodID GSA reimbursement method (companies using GSA only; 0 = Expense Amount Capped, 1 = GSA Amount, 2 = GSA Amount No Expense Amount).
StrictFilteringException Setting strict filtering exception to true will make this category available for all departments, regardless of other filtering settings (companies using strict filtering only; 1 = true, 0 = false).
SupressBillable Hide the billable option for this category (1 = true, 0 = false).
SupressBillableDefaultValue For categories where SuppressBillable = 1, sets the default billable status for the category (1 = billable, 0 = non-billable).
DeductCommuteUnits If set to one, a user’s commute will be excluded from mileage expenses within this category (mileage expenses only; 1 = true, 0 = false).
CashAdvances If set to 1, all expenses in this expense category are treated as cash advances (1 = true, 0 = false).
DailyMealLimit If set to 1, all expenses in this category will be included in a user’s daily meal limit (1 = true, 0 = false).
Active The active status of the expense category (1 = active, 0 = inactive)
POST
/expensecategories
Expand Method
Description

For each expense category element in the POST body, this method will update expense category records for the user’s company corresponding to the IDs supplied. Any elements where new values were not provided will retain their current value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
ID body The unique ID of the expense category. Yes string
Name body The expense category name. No string
Description body The internal description for the expense category. No string
Data body Used to store various internal code values for the expense category. No string
ExpenseTypeID body The expense type ID (1 = Cash Expense, 2 = Mileage, 3 = Lodging, 4 = Meals, 5 = Rentals, 6 = Travel, 7 = Per-Diem, 8 = Hourly, 9 = Invoice) Yes string
MaxAmount body The maximum expense amount permitted for this expense category. No string
MaxAmountCurrencyType body The currency code for the maximum amount (i.e. ‘GBP’, ‘USD’). No string
GLCode body The general ledger code associated with this expense category. No string
FilterDepartmentID body The ID of the department associated with this expense category. No string
PrepaidCode body The prepaid code associated with this expense category (cash expense types only). No string
UseNPI body Show Physician (companies using NPI only; 1 = true, 0 = false). No string
RequireNPI body Require Physician (companies using NPI only; 1 = true, 0 = false). No string
RequireReceiptOverride body Determines whether this category will use the standard receipt requirement threshold amount, or override it (0 = Inherit From Policy, 1 = Use Threshold Amount). No string
RequireReceiptThresholdAmount body Sets the override threshold amount for this category. No string
DetailedMealAttendees body Require detailed meal attendees (1 = true, 0 = false). No string
PersonalExpenses body Designates the category as pertaining to personal expenses (1 = true, 0 = false). No string
RequireReason body Require a reason for expenses in this category (1 = true, 0 = false). No string
StrictFilteringException body Setting strict filtering exception to true will make this category available for all departments, regardless of other filtering settings (companies using strict filtering only; 1 = true, 0 = false). No string
SupressBillable body Hide the billable option for this category (1 = true, 0 = false). No string
SupressBillableDefaultValue body For categories where SuppressBillable = 1, sets the default billable status for the category (1 = billable, 0 = non-billable). No string
DeductCommuteUnits body If set to one, a user’s commute will be excluded from mileage expenses within this category (mileage expenses only; 1 = true, 0 = false). No string
CashAdvances body If set to 1, all expenses in this expense category are treated as cash advances (1 = true, 0 = false). No string
DailyMealLimit body If set to 1, all expenses in this category will be included in a user’s daily meal limit (1 = true, 0 = false). No string
Active body The active status of the expense category (1 = active, 0 = inactive) No string
CPDBreakfast body Expense category used for CPD breakfast expenses (meal expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDLunch body Expense category used for CPD lunch expenses (meal expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDDinner body Expense category used for CPD dinner expenses (meal expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDIncidentals body Expense category used for CPD incidental expenses (cash expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDLodging body Expense category used for CPD lodging expenses (companies using CPD only; 1 = true, 0 = false). No string
CPDReimbursementMethodID body CPD reimbursement method (companies using CPD only; 0 = Expense Amount Capped, 1 = CPD Amount, 2 = CPD Amount No Expense Amount). No string
UseGSA body Expense category uses GSA (companies using GSA only; 1 = true, 0 = false). No string
GSABreakfast body Expense category used for GSA breakfast expenses (meal expense types for companies using GSA only; 1 = true, 0 = false). No string
GSALunch body Expense category used for GSA lunch expenses (meal expense types for companies using GSA only; 1 = true, 0 = false). No string
GSADinner body Expense category used for GSA dinner expenses (meal expense types for companies using GSA only; 1 = true, 0 = false). No string
GSAIncidentals body Expense category used for GSA incidental expenses (cash expense types for companies using GSA only; 1 = true, 0 = false). No string
GSALodging body Expense category used for GSA lodging expenses (companies using GSA only; 1 = true, 0 = false). No string
GSAReimbursementMethodID body GSA reimbursement method (companies using GSA only; 0 = Expense Amount Capped, 1 = GSA Amount, 2 = GSA Amount No Expense Amount). No string
Example Request
JSON XML 
[
    {
        "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e",
        "Name": "Sales & Marketing:6032",
        "Description": "",
        "Data": "",
        "ExpenseTypeID": 1,
        "MaxAmount": 0,
        "MaxAmountCurrencyType": "USD",
        "GLCode": "6032",
        "FilterDepartmentID": "1a727dfe-4c9f-4108-ac0d-4fa5d512f83c",
        "PrepaidCode": "",
        "RequireReceiptOverride": 0,
        "RequireReceiptThresholdAmount": 0,
        "DetailedMealAttendees": 0,
        "PersonalExpenses": 0,
        "RequireReason": 0,
        "StrictFilteringException": 0,
        "SupressBillable": 0,
        "SupressBillableDefaultValue": 0,
        "DeductCommuteUnits": 0,
        "CashAdvances": 0,
        "DailyMealLimit": 0,
        "Active": 0,
        "UseNPI": 0,
        "RequireNPI": 0,
        "CPDBreakfast": 0,
        "CPDLunch": 0,
        "CPDDinner": 0,
        "CPDIncidentals": 0,
        "CPDLodging": 0,
        "CPDReimbursementMethodID": 0,
        "CPDListID": "",
        "UseGSA": 0,
        "GSABreakfast": 0,
        "GSALunch": 0,
        "GSADinner": 0,
        "GSAIncidentals": 0,
        "GSALodging": 0,
        "GSAReimbursementMethodID": 0
    },
    {
        "ID": "393ad8b8-a370-40c3-9252-60244fa7a6bd",
        "Name": "Accounting:6033",
        "Description": "",
        "Data": "",
        "ExpenseTypeID": 1,
        "MaxAmount": 100,
        "MaxAmountCurrencyType": "USD",
        "GLCode": "6033",
        "FilterDepartmentID": "1a727dfe-4c9f-4108-ac0d-4fa5d512f83c",
        "PrepaidCode": "",
        "RequireReceiptOverride": 0,
        "RequireReceiptThresholdAmount": 0,
        "DetailedMealAttendees": 0,
        "PersonalExpenses": 0,
        "RequireReason": 0,
        "StrictFilteringException": 0,
        "SupressBillable": 0,
        "SupressBillableDefaultValue": 0,
        "DeductCommuteUnits": 0,
        "CashAdvances": 0,
        "DailyMealLimit": 0,
        "Active": 0,
        "UseNPI": 0,
        "RequireNPI": 0,
        "CPDBreakfast": 0,
        "CPDLunch": 0,
        "CPDDinner": 0,
        "CPDIncidentals": 0,
        "CPDLodging": 0,
        "CPDReimbursementMethodID": 0,
        "CPDListID": "",
        "UseGSA": 0,
        "GSABreakfast": 0,
        "GSALunch": 0,
        "GSADinner": 0,
        "GSAIncidentals": 0,
        "GSALodging": 0,
        "GSAReimbursementMethodID": 0
    }
]

<ExpenseCategories>
    <ExpenseCategory>
        <ID>9f903b49-64dc-45c8-8216-2928ed2b6b2e</ID>
        <Name>Sales & Marketing:6032</Name>
        <Description />
        <Data />
        <ExpenseTypeID>1</ExpenseTypeID>
        <MaxAmount>0.0000</MaxAmount>
        <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
        <GLCode>6032</GLCode>
        <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
        <PrepaidCode />
        <RequireReceiptOverride>0</RequireReceiptOverride>
        <RequireReceiptThresholdAmount>0.0000</RequireReceiptThresholdAmount>
        <DetailedMealAttendees>0</DetailedMealAttendees>
        <PersonalExpenses>0</PersonalExpenses>
        <RequireReason>0</RequireReason>
        <StrictFilteringException>0</StrictFilteringException>
        <SupressBillable>0</SupressBillable>
        <SupressBillableDefaultValue>0</SupressBillableDefaultValue>
        <DeductCommuteUnits>0</DeductCommuteUnits>
        <CashAdvances>0</CashAdvances>
        <DailyMealLimit>0</DailyMealLimit>
        <Active>0</Active>
        <UseNPI>0</UseNPI>
        <RequireNPI>0</RequireNPI>
        <CPDBreakfast>0</CPDBreakfast>
        <CPDLunch>0</CPDLunch>
        <CPDDinner>0</CPDDinner>
        <CPDIncidentals>0</CPDIncidentals>
        <CPDLodging>0</CPDLodging>
        <CPDReimbursementMethodID>0</CPDReimbursementMethodID>
        <CPDListID />
        <UseGSA>0</UseGSA>
        <GSABreakfast>0</GSABreakfast>
        <GSALunch>0</GSALunch>
        <GSADinner>0</GSADinner>
        <GSAIncidentals>0</GSAIncidentals>
        <GSALodging>0</GSALodging>
        <GSAReimbursementMethodID>0</GSAReimbursementMethodID>
    </ExpenseCategory>
    <ExpenseCategory>
        <ID>393ad8b8-a370-40c3-9252-60244fa7a6bd</ID>
        <Name>Sales & Marketing:6033</Name>
        <Description />
        <Data />
        <ExpenseTypeID>1</ExpenseTypeID>
        <MaxAmount>100.0000</MaxAmount>
        <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
        <GLCode>6033</GLCode>
        <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
        <PrepaidCode />
        <RequireReceiptOverride>0</RequireReceiptOverride>
        <RequireReceiptThresholdAmount>0.0000</RequireReceiptThresholdAmount>
        <DetailedMealAttendees>0</DetailedMealAttendees>
        <PersonalExpenses>0</PersonalExpenses>
        <RequireReason>0</RequireReason>
        <StrictFilteringException>0</StrictFilteringException>
        <SupressBillable>0</SupressBillable>
        <SupressBillableDefaultValue>0</SupressBillableDefaultValue>
        <DeductCommuteUnits>0</DeductCommuteUnits>
        <CashAdvances>0</CashAdvances>
        <DailyMealLimit>0</DailyMealLimit>
        <Active>0</Active>
        <UseNPI>0</UseNPI>
        <RequireNPI>0</RequireNPI>
        <CPDBreakfast>0</CPDBreakfast>
        <CPDLunch>0</CPDLunch>
        <CPDDinner>0</CPDDinner>
        <CPDIncidentals>0</CPDIncidentals>
        <CPDLodging>0</CPDLodging>
        <CPDReimbursementMethodID>0</CPDReimbursementMethodID>
        <CPDListID />
        <UseGSA>0</UseGSA>
        <GSABreakfast>0</GSABreakfast>
        <GSALunch>0</GSALunch>
        <GSADinner>0</GSADinner>
        <GSAIncidentals>0</GSAIncidentals>
        <GSALodging>0</GSALodging>
        <GSAReimbursementMethodID>0</GSAReimbursementMethodID>
    </ExpenseCategory>
</ExpenseCategories>
Response

A separate status should be returned for each record, either "Updated" or "Error" with a detailed error message. HTTP Status should be 200.

Example Response
JSON XML 
[
    {
        "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e",
        "Status": "Updated",
        "Message": ""
    },
    {
        "ID": "393ad8b8-a370-40c3-9252-60244fa7a6bd",
        "Status": "Error",
        "Message": "Expense Category ID supplied is not valid."
    }
]

<Results>
    <Result>
        <ID>9f903b49-64dc-45c8-8216-2928ed2b6b2e</ID>
        <Status>Updated</Status>
        <Message />
    </Result>
    <Result>
        <ID>393ad8b8-a370-40c3-9252-60244fa7a6bd</ID>
        <Status>Error</Status>
        <Message>Expense Category ID supplied is not valid.</Message>
    </Result>
</Results>
Field Value Description
ID Unique ID of the department.
Status Returns either "Updated" or "Error"
Message Detailed message when Status returns an "Error".
PUT
/expensecategories
Expand Method
Description

This method creates a new expense category record for the user’s company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
Name body The expense category name. No string
Description body The internal description for the expense category. No string
Data body Used to store various internal code values for the expense category. No string
ExpenseTypeID body The expense type ID (1 = Cash Expense, 2 = Mileage, 3 = Lodging, 4 = Meals, 5 = Rentals, 6 = Travel, 7 = Per-Diem, 8 = Hourly, 9 = Invoice) Yes string
MaxAmount body The maximum expense amount permitted for this expense category. No string
MaxAmountCurrencyType body The currency code for the maximum amount (i.e. ‘GBP’, ‘USD’). No string
GLCode body The general ledger code associated with this expense category. No string
FilterDepartmentID body The ID of the department associated with this expense category. No string
PrepaidCode body The prepaid code associated with this expense category (cash expense types only). No string
UseNPI body Show Physician (companies using NPI only; 1 = true, 0 = false). No string
RequireNPI body Require Physician (companies using NPI only; 1 = true, 0 = false). No string
RequireReceiptOverride body Determines whether this category will use the standard receipt requirement threshold amount, or override it (0 = Inherit From Policy, 1 = Use Threshold Amount). No string
RequireReceiptThresholdAmount body Sets the override threshold amount for this category. No string
DetailedMealAttendees body Require detailed meal attendees (1 = true, 0 = false). No string
PersonalExpenses body Designates the category as pertaining to personal expenses (1 = true, 0 = false). No string
RequireReason body Require a reason for expenses in this category (1 = true, 0 = false). No string
StrictFilteringException body Setting strict filtering exception to true will make this category available for all departments, regardless of other filtering settings (companies using strict filtering only; 1 = true, 0 = false). No string
SupressBillable body Hide the billable option for this category (1 = true, 0 = false). No string
SupressBillableDefaultValue body For categories where SuppressBillable = 1, sets the default billable status for the category (1 = billable, 0 = non-billable). No string
DeductCommuteUnits body If set to one, a user’s commute will be excluded from mileage expenses within this category (mileage expenses only; 1 = true, 0 = false). No string
CashAdvances body If set to 1, all expenses in this expense category are treated as cash advances (1 = true, 0 = false). No string
DailyMealLimit body If set to 1, all expenses in this category will be included in a user’s daily meal limit (1 = true, 0 = false). No string
Active body The active status of the expense category (1 = active, 0 = inactive) No string
CPDBreakfast body Expense category used for CPD breakfast expenses (meal expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDLunch body Expense category used for CPD lunch expenses (meal expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDDinner body Expense category used for CPD dinner expenses (meal expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDIncidentals body Expense category used for CPD incidental expenses (cash expense types for companies using CPD only; 1 = true, 0 = false). No string
CPDLodging body Expense category used for CPD lodging expenses (companies using CPD only; 1 = true, 0 = false). No string
CPDReimbursementMethodID body CPD reimbursement method (companies using CPD only; 0 = Expense Amount Capped, 1 = CPD Amount, 2 = CPD Amount No Expense Amount). No string
UseGSA body Expense category uses GSA (companies using GSA only; 1 = true, 0 = false). No string
GSABreakfast body Expense category used for GSA breakfast expenses (meal expense types for companies using GSA only; 1 = true, 0 = false). No string
GSALunch body Expense category used for GSA lunch expenses (meal expense types for companies using GSA only; 1 = true, 0 = false). No string
GSADinner body Expense category used for GSA dinner expenses (meal expense types for companies using GSA only; 1 = true, 0 = false). No string
GSAIncidentals body Expense category used for GSA incidental expenses (cash expense types for companies using GSA only; 1 = true, 0 = false). No string
GSALodging body Expense category used for GSA lodging expenses (companies using GSA only; 1 = true, 0 = false). No string
GSAReimbursementMethodID body GSA reimbursement method (companies using GSA only; 0 = Expense Amount Capped, 1 = GSA Amount, 2 = GSA Amount No Expense Amount). No string
Example Request
JSON XML 
{
  "Name": "Sales & Marketing:6032",
  "Description": "",
  "Data": "",
  "ExpenseTypeID": 1,
  "MaxAmount": 0,
  "MaxAmountCurrencyType": "USD",
  "GLCode": "6032",
  "FilterDepartmentID": "1a727dfe-4c9f-4108-ac0d-4fa5d512f83c",
  "PrepaidCode": "",
  "RequireReceiptOverride": 0,
  "RequireReceiptThresholdAmount": 0,
  "DetailedMealAttendees": 0,
  "PersonalExpenses": 0,
  "RequireReason": 0,
  "StrictFilteringException": 0,
  "SupressBillable": 0,
  "SupressBillableDefaultValue": 0,
  "DeductCommuteUnits": 0,
  "CashAdvances": 0,
  "DailyMealLimit": 0,
  "Active": 0,
  "UseNPI": 0,
  "RequireNPI": 0,
  "CPDBreakfast": 0,
  "CPDLunch": 0,
  "CPDDinner": 0,
  "CPDIncidentals": 0,
  "CPDLodging": 1,
  "CPDReimbursementMethodID": 2,
  "CPDListID": "c2fd97b9-4a3e-4756-84b3-ebd81ddf7831",
  "UseGSA": 0,
  "GSABreakfast": 0,
  "GSALunch": 0,
  "GSADinner": 0,
  "GSAIncidentals": 0,
  "GSALodging": 0,
  "GSAReimbursementMethodID": 0
}

<ExpenseCategory>
  <Name>Sales & Marketing:6032</Name>
  <Description />
  <Data />
  <ExpenseTypeID>1</ExpenseTypeID>
  <MaxAmount>0.0000</MaxAmount>
  <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
  <GLCode>6032</GLCode>
  <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
  <PrepaidCode />
  <RequireReceiptOverride>0</RequireReceiptOverride>
  <RequireReceiptThresholdAmount>0.0000</RequireReceiptThresholdAmount>
  <DetailedMealAttendees>0</DetailedMealAttendees>
  <PersonalExpenses>0</PersonalExpenses>
  <RequireReason>0</RequireReason>
  <StrictFilteringException>0</StrictFilteringException>
  <SupressBillable>0</SupressBillable>
  <SupressBillableDefaultValue>0</SupressBillableDefaultValue>
  <DeductCommuteUnits>0</DeductCommuteUnits>
  <CashAdvances>0</CashAdvances>
  <DailyMealLimit>0</DailyMealLimit>
  <Active>0</Active>
  <UseNPI>0</UseNPI>
  <RequireNPI>0</RequireNPI>
  <CPDBreakfast>0</CPDBreakfast>
  <CPDLunch>0</CPDLunch>
  <CPDDinner>0</CPDDinner>
  <CPDIncidentals>0</CPDIncidentals>
  <CPDLodging>1</CPDLodging>
  <CPDReimbursementMethodID>2</CPDReimbursementMethodID>
  <CPDListID>c2fd97b9-4a3e-4756-84b3-ebd81ddf7831</CPDListID>
  <UseGSA>0</UseGSA>
  <GSABreakfast>0</GSABreakfast>
  <GSALunch>0</GSALunch>
  <GSADinner>0</GSADinner>
  <GSAIncidentals>0</GSAIncidentals>
  <GSALodging>0</GSALodging>
  <GSAReimbursementMethodID>0</GSAReimbursementMethodID>
</ExpenseCategory>
Response

If successful, this method should return the ID of the new department.

Example Response
JSON XML 

{
  "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e"
}

<ID>9f903b49-64dc-45c8-8216-2928ed2b6b2e</ID>
Field Value Description
ID Unique ID of the department.
Status Returns either "Updated" or "Error"
Message Detailed message when Status returns an "Error".
GET
/expensecategories/{id}
Expand Method
Description

This method returns a list of one or more expense categories for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Expense category ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response

A separate status should be returned for each record, either "Updated" or "Error" with a detailed error message. HTTP Status should be 200.

JSON XML 
{
    "ExpenseCategories": [
        {
            "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e",
            "Name": "Sales & Marketing:6032",
            "Description": "",
            "Data": "",
            "ExpenseTypeID": 1,
            "MaxAmount": 0,
            "MaxAmountCurrencyType": "USD",
            "GLCode": "6032",
            "FilterDepartmentID": "1a727dfe-4c9f-4108-ac0d-4fa5d512f83c",
            "PrepaidCode": "",
            "RequireReceiptOverride": 0,
            "RequireReceiptThresholdAmount": 0,
            "DetailedMealAttendees": 0,
            "PersonalExpenses": 0,
            "RequireReason": 1,
            "StrictFilteringException": 0,
            "SupressBillable": 0,
            "SupressBillableDefaultValue": 0,
            "DeductCommuteUnits": 0,
            "CashAdvances": 0,
            "DailyMealLimit": 0,
            "Active": 0,
            "UseNPI": 0,
            "RequireNPI": 0,
            "CPDBreakfast": 0,
            "CPDLunch": 0,
            "CPDDinner": 0,
            "CPDIncidentals": 0,
            "CPDLodging": 0,
            "CPDReimbursementMethodID": 0,
            "CPDListID": "",
            "UseGSA": 0,
            "GSABreakfast": 0,
            "GSALunch": 0,
            "GSADinner": 0,
            "GSAIncidentals": 0,
            "GSALodging": 0,
            "GSAReimbursementMethodID": 0
        }
    ]
}



<ExpenseCategories>
    <ExpenseCategory>
        <ID>9f903b49-64dc-45c8-8216-2928ed2b6b2e</ID>
        <Name>Sales & Marketing:6032</Name>
        <Description />
        <Data />
        <ExpenseTypeID>1</ExpenseTypeID>
        <MaxAmount>0.0000</MaxAmount>
        <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
        <GLCode>6032</GLCode>
        <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
        <PrepaidCode />
        <RequireReceiptOverride>0</RequireReceiptOverride>
        <RequireReceiptThresholdAmount>0.0000</RequireReceiptThresholdAmount>
        <DetailedMealAttendees>0</DetailedMealAttendees>
        <PersonalExpenses>0</PersonalExpenses>
        <RequireReason>1</RequireReason>
        <StrictFilteringException>0</StrictFilteringException>
        <SupressBillable>0</SupressBillable>
        <SupressBillableDefaultValue>0</SupressBillableDefaultValue>
        <DeductCommuteUnits>0</DeductCommuteUnits>
        <CashAdvances>0</CashAdvances>
        <DailyMealLimit>0</DailyMealLimit>
        <Active>0</Active>
        <UseNPI>0</UseNPI>
        <RequireNPI>0</RequireNPI>
        <CPDBreakfast>0</CPDBreakfast>
        <CPDLunch>0</CPDLunch>
        <CPDDinner>0</CPDDinner>
        <CPDIncidentals>0</CPDIncidentals>
        <CPDLodging>0</CPDLodging>
        <CPDReimbursementMethodID>0</CPDReimbursementMethodID>
        <CPDListID />
        <UseGSA>0</UseGSA>
        <GSABreakfast>0</GSABreakfast>
        <GSALunch>0</GSALunch>
        <GSADinner>0</GSADinner>
        <GSAIncidentals>0</GSAIncidentals>
        <GSALodging>0</GSALodging>
        <GSAReimbursementMethodID>0</GSAReimbursementMethodID>
    </ExpenseCategory>
</ExpenseCategories>
Field Value Description
ID The unique ID of the expense category.
Name The expense category name.
Description The internal description for the expense category.
Data Used to store various internal code values for the expense category.
ExpenseTypeID The expense type ID (1 = Cash Expense, 2 = Mileage, 3 = Lodging, 4 = Meals, 5 = Rentals, 6 = Travel, 7 = Per-Diem, 8 = Hourly, 9 = Invoice)
MaxAmount The maximum expense amount permitted for this expense category.
MaxAmountCurrencyType The currency code for the maximum amount (i.e. ‘GBP’, ‘USD’).
GLCode The general ledger code associated with this expense category.
FilterDepartmentID The ID of the department associated with this expense category.
PrepaidCode The prepaid code associated with this expense category (cash expense types only).
UseNPI Show Physician (companies using NPI only; 1 = true, 0 = false).
RequireNPI Require Physician (companies using NPI only; 1 = true, 0 = false).
RequireReceiptOverride Determines whether this category will use the standard receipt requirement threshold amount, or override it (0 = Inherit From Policy, 1 = Use Threshold Amount).
RequireReceiptThresholdAmount Sets the override threshold amount for this category.
DetailedMealAttendees Require detailed meal attendees (1 = true, 0 = false).
PersonalExpenses Designates the category as pertaining to personal expenses (1 = true, 0 = false).
RequireReason Require a reason for expenses in this category (1 = true, 0 = false).
CPDBreakfast Expense category used for CPD breakfast expenses (meal expense types for companies using CPD only; 1 = true, 0 = false).
CPDLunch Expense category used for CPD lunch expenses (meal expense types for companies using CPD only; 1 = true, 0 = false).
CPDDinner Expense category used for CPD dinner expenses (meal expense types for companies using CPD only; 1 = true, 0 = false).
CPDIncidentals Expense category used for CPD incidental expenses (cash expense types for companies using CPD only; 1 = true, 0 = false).
CPDLodging Expense category used for CPD lodging expenses (companies using CPD only; 1 = true, 0 = false).
CPDReimbursementMethodID CPD reimbursement method (companies using CPD only; 0 = Expense Amount Capped, 1 = CPD Amount, 2 = CPD Amount No Expense Amount).
CPDListID The unique ID of the Custom Per Diem List.
UseGSA Expense category uses GSA (companies using GSA only; 1 = true, 0 = false).
GSABreakfast Expense category used for GSA breakfast expenses (meal expense types for companies using GSA only; 1 = true, 0 = false).
GSALunch Expense category used for GSA lunch expenses (meal expense types for companies using GSA only; 1 = true, 0 = false).
GSADinner Expense category used for GSA dinner expenses (meal expense types for companies using GSA only; 1 = true, 0 = false).
GSAIncidentals Expense category used for GSA incidental expenses (cash expense types for companies using GSA only; 1 = true, 0 = false).
GSALodging Expense category used for GSA lodging expenses (companies using GSA only; 1 = true, 0 = false).
GSAReimbursementMethodID GSA reimbursement method (companies using GSA only; 0 = Expense Amount Capped, 1 = GSA Amount, 2 = GSA Amount No Expense Amount).
StrictFilteringException Setting strict filtering exception to true will make this category available for all departments, regardless of other filtering settings (companies using strict filtering only; 1 = true, 0 = false).
SupressBillable Hide the billable option for this category (1 = true, 0 = false).
SupressBillableDefaultValue For categories where SuppressBillable = 1, sets the default billable status for the category (1 = billable, 0 = non-billable).
DeductCommuteUnits If set to one, a user’s commute will be excluded from mileage expenses within this category (mileage expenses only; 1 = true, 0 = false).
CashAdvances If set to 1, all expenses in this expense category are treated as cash advances (1 = true, 0 = false).
DailyMealLimit If set to 1, all expenses in this category will be included in a user’s daily meal limit (1 = true, 0 = false).
Active The active status of the expense category (1 = active, 0 = inactive)
GET
/expensereports
Expand Method
Description

This method returns a list of one or more processed expense reports.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
approvalcode query Approval code of single expense report. No string
startdate query Starting point for the processed date range. No string (YYYY-MM-DD)
enddate query Ending point for the processed date range. No string (YYYY-MM-DD)
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "ExpenseReports": [
        {
              "ID": "fdf32884-af87-4991-a7q4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeID": "jcerti001",
              "NonReimAmount": 0.0000,
              "ReimAmount": 292.0400,
              "TotalAmount": 292.0400,
              "Currency": "USD",
              "SubmittedDate": "2017-02-03",
              "InitialApprovalDate": "2017-02-03",
              "ProcessedDate": "2017-02-03",
              "ApprovalCode": 19,
              "InitialApproverEmail": "rrobot@certify.com",
              "StartDate": "2017-01-01",
              "EndDate": "2017-01-31",
              "ExpenseReportName": "Business Trip January 2017",
              "APSyncComplete": true,
              "EmpGLD1Name": "test",
              "EmpGLD1Code": "test",
              "EmpGLD2Name": "A",
              "EmpGLD2Code": "A",
              "EmpGLD3Name": "",
              "EmpGLD3Code": "",
              "EmpGLD4Name": "",
              "EmpGLD4Code": "",
              "EmpGLD5Name": "",
              "EmpGLD5Code": ""
        },
        {
              "ID": "a9109697-ew08-45f1-9338-994e046a07ed",
              "EmployeeDepartment": "General",
              "FirstName": "Robbie",
              "LastName": "The Robot",
              "EmployeeID": "rrobot002",
              "NonReimAmount": 34.4000,
              "ReimAmount": 0.0000,
              "TotalAmount": 34.4000,
              "Currency": "USD",
              "SubmittedDate": "2017-02-03",
              "InitialApprovalDate": "2017-02-03",
              "ProcessedDate": "2016-02-03",
              "ApprovalCode": 23,
              "InitialApproverEmail": "rrobot@certify.com",
              "StartDate": "2017-01-23",
              "EndDate": "2017-01-30",
              "ExpenseReportName": "Visit to Alpaca Farm, Inc.",
              "APSyncComplete": false,
              "EmpGLD1Name": "test",
              "EmpGLD1Code": "test",
              "EmpGLD2Name": "A",
              "EmpGLD2Code": "A",
              "EmpGLD3Name": "",
              "EmpGLD3Code": "",
              "EmpGLD4Name": "",
              "EmpGLD4Code": "",
              "EmpGLD5Name": "",
              "EmpGLD5Code": ""
        }]
}
    
<ExpenseReports>
    <ID>fdf32884-af87-49c1-a7q4-3e574ea6be88</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeID>jcerti001</EmployeeID>
    <NonReimAmount>0</NonReimAmount>
    <ReimAmount>292.04</ReimAmount>
    <TotalAmount>292.04</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2017-02-03</SubmittedDate>
    <InitialApprovalDate>2017-02-03</InitialApprovalDate>
    <ProcessedDate>2017-02-03</ProcessedDate>
    <ApprovalCode>19</ApprovalCode>
    <InitialApprov>rrobot@certify.com</InitialApprovalEmail>
    <StartDate>2017-01-01</StartDate>
    <EndDate>2017-01-31</EndDate>
    <ExpenseReportName>Business Trip January 2017</ExpenseReportName>
    <APSyncComplete>true</APSyncComplete>
    <EmpGLD1Name>test</EmpGLD1Name>
    <EmpGLD1Code>test</EmpGLD1Code>
    <EmpGLD2Name>A</EmpGLD2Name>
    <EmpGLD2Code>A</EmpGLD2Code>
    <EmpGLD3Name></EmpGLD3Name>
    <EmpGLD3Code></EmpGLD3Code>
    <EmpGLD4Name></EmpGLD4Name>
    <EmpGLD4Code></EmpGLD4Code>
    <EmpGLD5Name></EmpGLD5Name>
    <EmpGLD5Code></EmpGLD5Code>
</ExpenseReports>
<ExpenseReports>
    <ID>a9109697-ew08-45f1-93b8-994e046a07ed</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <EmployeeID>rrobot002</EmployeeID>
    <NonReimAmount>34.40</NonReimAmount>
    <ReimAmount>0</ReimAmount>
    <TotalAmount>34.40</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2016-02-03</SubmittedDate>
    <InitialApprovalDate>2016-02-03</InitialApprovalDate>
    <ProcessedDate>2016-02-03</ProcessedDate>
    <ApprovalCode>23</ApprovalCode>
    <StartDate>2017-01-23</StartDate>
    <EndDate>2017-01-30</EndDate>
    <ExpenseReportName>Visit to Alpaca Farm, Inc.</ExpenseReportName>
    <APSyncComplete>false</APSyncComplete>
    <EmpGLD1Name>test</EmpGLD1Name>
    <EmpGLD1Code>test</EmpGLD1Code>
    <EmpGLD2Name>A</EmpGLD2Name>
    <EmpGLD2Code>A</EmpGLD2Code>
    <EmpGLD3Name></EmpGLD3Name>
    <EmpGLD3Code></EmpGLD3Code>
    <EmpGLD4Name></EmpGLD4Name>
    <EmpGLD4Code></EmpGLD4Code>
    <EmpGLD5Name></EmpGLD5Name>
    <EmpGLD5Code></EmpGLD5Code>
</ExpenseReports>
Field Value Description
ID Unique ID of the Expense Report.
EmployeeDepartment Property fields of the employee who the expense report belongs to.
FirstName
LastName
EmployeeID
NonReimAmount Total non-reimbursable amount of the expense report.
ReimAmount Total reimbursable amount of the expense report.
TotalAmount Total amount, non-reimbursable + non-reimbursable amounts.
Currency Three letter code of the currency of the expense report. ISO 4217 format.
SubmittedDate The date the expense report was submitted for approval (yyyy-MM-dd).
InitialApprovalDate Date the first user approved the expense report.
ProcessedDate Date on which the expense report was processed. (YYYY-MM-DD)
ApprovalCode Approval code of the expense report.
InitialApproverEmail Email address of the first user to approve the expense report.
StartDate Start date of the expense report. (YYYY-MM-DD)
EndDate End date of the expense report. (YYYY-MM-DD)
ExpenseReportName Name of the expense report.
APSyncComplete Indicates whether the expense report has been synchronized with a third party AP system. (true/false)
EmpGLD1Name The name of the value of the Employee General Ledger Dimension 1.
EmpGLD1Code The code of the value of the Employee General Ledger Dimension 1.
EmpGLD2Name The labels and values of the Employee General Ledger Dimension 2-5 (see above).
EmpGLD2Code
EmpGLD3Name
EmpGLD3Code
EmpGLD4Name
EmpGLD4Code
EmpGLD5Name
EmpGLD5Code
GET
/expensereports/{id}
Expand Method
Description

This method returns a specific processed expense report associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Expense Report/Expense ID Yes string
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "ExpenseReports": [
        {
              "ID": "fdf32884-af87-4991-a7q4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeID": "jcerti001",
              "NonReimAmount": 0.0000,
              "ReimAmount": 292.0400,
              "TotalAmount": 292.0400,
              "Currency": "USD",
              "SubmittedDate": "2017-02-03",
              "InitialApprovalDate": "2017-02-03",
              "ProcessedDate": "2017-02-03",
              "ApprovalCode": 19,
              "StartDate": "2017-01-01",
              "EndDate": "2017-01-31",
              "ExpenseReportName": "Business Trip January 2017",
              "APSyncComplete": true,
              "EmpGLD1Name": "test",
              "EmpGLD1Code": "test",
              "EmpGLD2Name": "A",
              "EmpGLD2Code": "A",
              "EmpGLD3Name": "",
              "EmpGLD3Code": "",
              "EmpGLD4Name": "",
              "EmpGLD4Code": "",
              "EmpGLD5Name": "",
              "EmpGLD5Code": ""
        }]
}
    
<ExpenseReports>
    <ID>fdf32884-af87-49c1-a7q4-3e574ea6be88</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeID>jcerti001</EmployeeID>
    <NonReimAmount>0</NonReimAmount>
    <ReimAmount>292.04</ReimAmount>
    <TotalAmount>292.04</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2017-02-03</SubmittedDate>
    <InitialApprovalDate>2017-02-03</InitialApprovalDate>
    <ProcessedDate>2017-02-03</ProcessedDate>
    <ApprovalCode>19</ApprovalCode>
    <StartDate>2017-01-01</StartDate>
    <EndDate>2017-01-31</EndDate>
    <ExpenseReportName>Business Trip January 2017</ExpenseReportName>
    <APSyncComplete>true</APSyncComplete>
    <EmpGLD1Name>test</EmpGLD1Name>
    <EmpGLD1Code>test</EmpGLD1Code>
    <EmpGLD2Name>A</EmpGLD2Name>
    <EmpGLD2Code>A</EmpGLD2Code>
    <EmpGLD3Name></EmpGLD3Name>
    <EmpGLD3Code></EmpGLD3Code>
    <EmpGLD4Name></EmpGLD4Name>
    <EmpGLD4Code></EmpGLD4Code>
    <EmpGLD5Name></EmpGLD5Name>
    <EmpGLD5Code></EmpGLD5Code>
</ExpenseReports>
Field Value Description
ID Unique ID of the Expense Report.
EmployeeDepartment Property fields of the employee who the expense report belongs to.
FirstName
LastName
EmployeeID
NonReimAmount Total non-reimbursable amount of the expense report.
ReimAmount Total reimbursable amount of the expense report.
TotalAmount Total amount, non-reimbursable + non-reimbursable amounts.
Currency Three letter code of the currency of the expense report. ISO 4217 format.
SubmittedDate The date the expense report was submitted for approval (yyyy-MM-dd).
InitialApprovalDate Date the first user approved the expense report.
ProcessedDate Date on which the expense report was processed. (YYYY-MM-DD)
ApprovalCode Approval code of the expense report.
InitialApproverEmail Email address of the first user to approve the expense report.
StartDate Start date of the expense report. (YYYY-MM-DD)
EndDate End date of the expense report. (YYYY-MM-DD)
ExpenseReportName Name of the expense report.
APSyncComplete Indicates whether the expense report has been synchronized with a third party AP system. (true/false)
EmpGLD1Name The name of the value of the Employee General Ledger Dimension 1.
EmpGLD1Code The code of the value of the Employee General Ledger Dimension 1.
EmpGLD2Name The labels and values of the Employee General Ledger Dimension 2-5 (see above).
EmpGLD2Code
EmpGLD3Name
EmpGLD3Code
EmpGLD4Name
EmpGLD4Code
EmpGLD5Name
EmpGLD5Code
GET
/expensereports/{id}/expenses
Expand Method
Description

This method returns all expenses for the processed expense report associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Expense Report/Expense ID Yes string
approvalcode query Approval code of single expense report. No string
startdate query Starting point for the processed date range. No string (YYYY-MM-DD)
enddate query Ending point for the processed date range. No string (YYYY-MM-DD)
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "Expense": [
        {
              "ID": "b65455e0-89d5-4910-82bf-cadfbf5c4126",
              "ExpenseReportID": "fdf33884-af87-2891-a7d4-3e574ea6be88",
              "FirstName": "Jack",
              "LastName": "Certi",
              "Email": "jcerti@certify.com",
              "EmployeeID": "jcerti001",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "ExpenseType": "Lodging",
              "ExpenseCategory": "Lodging",
              "ExpenseCategoryGLCode": "03",
              "Amount": 192.9300,
              "Billable": false,
              "Reimbursable": true,
              "ReimAmount": 191.9600,
              "SubmittedAmount": 0.0000,
              "ExpenseDate": "2016-05-03",
              "PostingDate": "",
              "Vendor": "Mountain View Hotel",
              "Location": "Mountain View, CA",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "Currency": "USD",
              "SubmittedCurrency": "",
              "Reason": "Hotel Stay",
              "VATAmount": 0.0000,
              "HSTAmount": 0.0000,
              "PSTAmount": 0.0000,
              "ExpenseTextGLD1Label": "Text GLD Expense",
              "ExpenseTextGLD1": "business",
              "ExpenseTextGLD2Label": "Numbers Only GLD",
              "ExpenseTextGLD2": "123",
              "ExpenseReportGLD1Label": "Food",
              "ExpenseReportGLD1Name": "Apples and Oranges",
              "ExpenseReportGLD1Code": "A123",
              "ReceiptImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C",
              "PaymentCardName": "Company Visa",
              "CCLast": "0005"        
        },
        {
              "ID": "e373a213-1dd3-4e3d-83b7-786bd9a5e201",
              "ExpenseReportID": "9b7146b0-3e92-4745-babf-8bda8973238a",
              "FirstName": "Robbie",
              "LastName": "The Robot",
              "Email": "rrobot@certify.com",
              "EmployeeID": "rrobot002",
              "DepartmentName": "Marketing",
              "DepartmentCode": "02",
              "ExpenseType": "Travel",
              "ExpenseCategory": Airfare",
              "ExpenseCategoryGLCode": "01",
              "Amount": 150.0000,
              "Billable": false,
              "Reimbursable": false,
              "ReimAmount": 0.0000,
              "SubmittedAmount": 0.0000,
              "ExpenseDate": "2016-06-22",
              "PostingDate": "",
              "Vendor": "Delta",
              "ProcessedDate": "2016-06-22",
              "Processed": true,
              "Currency": "USD",
              "SubmittedCurrency": "",
              "Reason": "Airfare",
              "VATAmount": 0.0000,
              "HSTAmount": 0.0000,
              "PSTAmount": 0.0000,
              "ExpenseTextGLD1Label": "Text GLD Expense",
              "ExpenseTextGLD1": "Marketing Convention",
              "ExpenseTextGLD2Label": "Numbers Only GLD",
              "ExpenseReportGLD1Label": "Food",
              "ExpenseReportGLD1Name": "Surf and Turf",
              "ExpenseReportGLD1Code": "st001",
              "TravelFrom": "PWM",
              "TravelTo": "BOS"
              "ReceiptImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"
              "PaymentCardName": "Company Mastercard"
              "CCLast": "0005"
        }]
}
    
<Expenses>
    <Expense>
      <ID>b65455e0-89d5-4910-82bf-cadfbf5c4126</ID>
      <ExpenseReportID>fdf33884-af87-289-a7d4-3e574ea6be88</ExpenseReportID>
      <FirstName>Jack</FirstName>
      <LastName>Certi</LastName>
      <Email>jcerti@certify.com</Email>
      <EmployeeID>jcerti001</EmployeeID>
      <DepartmentName>General</DepartmentName>
      <DepartmentCode>01</DepartmentCode>
      <ExpenseType>Lodging</ExpenseType>
      <ExpenseCategory>Lodging</ExpenseCategory>
      <ExpenseCategoryGLCode>03</ExpenseCategoryGLCode>
      <Amount>192.9300</Amount>
      <Billable>false</Billable>
      <Reimbursable>true</Reimbursable>
      <ReimAmount>191.9600</ReimAmount>
      <SubmittedAmount>0.0000</SubmittedAmount>
      <ExpenseDate>2016-05-03</ExpenseDate>
      <PostingDate></PostingDate>
      <Vendor>Mountain View Hotel</Vendor>
      <Location>Mountain View, CA</Location>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <Currency>USD</Currency>
      <SubmittedCurrency></SubmittedCurrency>
      <Reason>Hotel stay</Reason>
      <VATAmount>0.0000</VATAmount>
      <HSTAmount>0.0000</HSTAmount>
      <PSTAmount>0.0000</PSTAmount>
      <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
      <ExpenseTextGLD1>business</ExpenseTextGLD1>
      <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
      <ExpenseTextGLD2>123</ExpenseTextGLD2>
      <ExpenseTextGLD3Label />
      <ExpenseTextGLD3 />
      <ExpenseTextGLD4Label />
      <ExpenseTextGLD4 />
      <ExpenseTextGLD5Label />
      <ExpenseTextGLD5 />
      <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
      <ExpenseReportGLD1Name>Apples and Oranges</ExpenseReportGLD1Name>
      <ExpenseReportGLD1Code>A123</ExpenseReportGLD1Code>
      <ExpenseReportGLD2Label />
      <ExpenseReportGLD2Name />
      <ExpenseReportGLD2Code />
      <ExpenseReportGLD3Label />
      <ExpenseReportGLD3Name />
      <ExpenseReportGLD3Code />
      <ExpenseReportGLD4Label />
      <ExpenseReportGLD4Name />
      <ExpenseReportGLD4Code />
      <ExpenseReportGLD5Label />
      <ExpenseReportGLD5Name />
      <ExpenseReportGLD5Code />
      <TravelFrom />
      <TravelTo />
      <ReceiptImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</ReceiptImageLink>
      <PaymentCardName>Company Visa</PaymentCardName>
      <CCLast>0005</CCLast>
    </Expense>
    <Expense>
      <ID>e373a213-1dd3-4e3d-83b7-566bd9a5e201</ID>
      <ExpenseReportID>9b7146b0-3e92-4745-babf-8bda3273238a</ExpenseReportID>
      <FirstName>Robbie</FirstName>
      <LastName>The Robot</LastName>
      <Email>rrobot@certify.com</Email>
      <EmployeeID>rrobot002</EmployeeID>
      <DepartmentName>Marketing</DepartmentName>
      <DepartmentCode>02</DepartmentCode>
      <ExpenseType>Travel</ExpenseType>
      <ExpenseCategory>Airfare</ExpenseCategory>
      <ExpenseCategoryGLCode>01</ExpenseCategoryGLCode>
      <Amount>150.0000</Amount>
      <Billable>false</Billable>
      <Reimbursable>false</Reimbursable>
      <ReimAmount>0.0000</ReimAmount>
      <SubmittedAmount>0.0000</SubmittedAmount>
      <ExpenseDate>2016-06-22</ExpenseDate>
      <PostingDate></PostingDate>
      <Vendor>Delta</Vendor>
      <ProcessedDate>2016-06-22</ProcessedDate>
      <Processed>true</Processed>
      <Currency>USD</Currency>
      <SubmittedCurrency></SubmittedCurrency>
      <Reason />
      <VATAmount>0.0000</VATAmount>
      <HSTAmount>0.0000</HSTAmount>
      <PSTAmount>0.0000</PSTAmount>
      <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
      <ExpenseTextGLD1>Marketing Convention</ExpenseTextGLD1>
      <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
      <ExpenseTextGLD2 />
      <ExpenseTextGLD3Label />
      <ExpenseTextGLD3 />
      <ExpenseTextGLD4Label />
      <ExpenseTextGLD4 />
      <ExpenseTextGLD5Label />
      <ExpenseTextGLD5 />
      <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
      <ExpenseReportGLD1Name>Surf and Turf</ExpenseReportGLD1Name>
      <ExpenseReportGLD1Code>st001</ExpenseReportGLD1Code>
      <ExpenseReportGLD2Label />
      <ExpenseReportGLD2Name />
      <ExpenseReportGLD2Code />
      <ExpenseReportGLD3Label />
      <ExpenseReportGLD3Name />
      <ExpenseReportGLD3Code />
      <ExpenseReportGLD4Label />
      <ExpenseReportGLD4Name />
      <ExpenseReportGLD4Code />
      <ExpenseReportGLD5Label />
      <ExpenseReportGLD5Name />
      <ExpenseReportGLD5Code />
      <TravelFrom>PWM</TravelFrom>
      <TravelTo>BOS</TravelTo>
      <ReceiptImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</ReceiptImageLink>
      <PaymentCardName>Company Mastercard</PaymentCardName>
      <CCLast>0005</CCLast>
    </Expense>
  </Expenses>
Field Value Description
ID Unique ID of the expense.
ExpenseReportID Unique ID of the expense report the expense is attached to.
FirstName Property fields of the employee who the expense report belongs to.
LastName
Email
EmployeeID
DepartmentName Name of the department of the expense.
DepartmentCode Code of the department of the expense.
ExpenseType Type of expense (Mileage, Lodging, Meals, etc.).
ExpenseCategory Expense category of the expense.
ExpenseCategoryGLCode GL Code of the expense category of the expense.
Amount Total amount of the expense.
Billable Indicates whether the expense is billable (true/false).
Reimbursable Indicates whether the expense is reimbursable (true/false).
ReimAmount Reimbursable amount of the expense.
Submitted Amount Total amount of the expense as supplied by credit card feed.
ExpenseDate The date of the expense (yyyy-MM-dd).
PostingDate The posting date of the expense as supplied by credit card feed (yyyy-MM-dd).
Vendor The vendor of the expense.
Location The location of the expense.
ProcessedDate The date the expense was processed on, if applicable (yyyy-MM-dd).
Processed Indicates whether the expense has been processed (true/false).
Currency Three letter code of the currency of the expense. ISO 4217 format. Ex: “USD”
SubmittedCurrency Three letter code of the currency of the expense as supplied by credit card feed. ISO 4217 format. Ex: “USD”
Reason The text entered in the reason field of the expense
VATAmount The value-added tax amount of the expense, if applicable.
HSTAmount The harmonized sales tax amount of the expense, if applicable.
PSTAmount The provincial sales tax amount of the expense, if applicable.
ExpenseTextGLD1Label The label of the Expense Level Free-Text General Ledger Dimension 1.
ExpenseTextGLD1 The value of the Expense Level Free-Text General Ledger Dimension 1
ExpenseTextGLD2Label The labels and values of the Expense Level Free-Text General Ledger Dimension 2-5 (see above).
ExpenseTextGLD2
ExpenseTextGLD3Label
ExpenseTextGLD3
ExpenseTextGLD4Label
ExpenseTextGLD4
ExpenseTextGLD5Label
ExpenseTextGLD5
ExpenseReportGLD1Label The label of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD1Name The name of the value of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD1Code The code of the value of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD2Label The labels and values of the Expense Report General Ledger Dimension 2-5 (see above).
ExpenseReportGLD2Name
ExpenseReportGLD2Code
ExpenseReportGLD3Label
ExpenseReportGLD3Name
ExpenseReportGLD3Code
ExpenseReportGLD4Label
ExpenseReportGLD4Name
ExpenseReportGLD4Code
ExpenseReportGLD5Label
ExpenseReportGLD5Name
ExpenseReportGLD5Code
TravelFrom The origin location or code for travel-based expense categories.
TravelTo The destination location or code for travel-based expense categories.
ReceiptImageLink The Certify URL provided to access the receipt image of this expense.
PaymentCardName The user supplied label of the Payment Card.
CCLast The last 4 digits of the credit card number used to pay for the expense as supplied by credit card feed.
GET
/expenses
Expand Method
Description

This method returns a list of one or more expenses from a procesed expense report.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
startdate query Starting point for the processed date range. No string (YYYY-MM-DD)
enddate query Ending point for the processed date range. No string (YYYY-MM-DD)
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "Expense": [
        {
              "ID": "b65455e0-89d5-4910-82bf-cadfbf5c4126",
              "ExpenseReportID": "fdf33884-af87-2891-a7d4-3e574ea6be88",
              "FirstName": "Jack",
              "LastName": "Certi",
              "Email": "jcerti@certify.com",
              "EmployeeID": "jcerti001",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "ExpenseType": "Lodging",
              "ExpenseCategory": "Lodging",
              "ExpenseCategoryGLCode": "03",
              "Amount": 192.9300,
              "Billable": false,
              "Reimbursable": true,
              "ReimAmount": 191.9600,
              "SubmittedAmount": 0.0000,
              "ExpenseDate": "2016-05-03"
              "PostingDate": ""
              "Vendor": "Mountain View Hotel",
              "Location": "Mountain View, CA",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "Currency": "USD",
              "SubmittedCurrency": "",
              "Reason": "Hotel Stay",
              "VATAmount": 0.0000,
              "HSTAmount": 0.0000,
              "PSTAmount": 0.0000,
              "ExpenseTextGLD1Label": "Text GLD Expense",
              "ExpenseTextGLD1": "business",
              "ExpenseTextGLD2Label": "Numbers Only GLD",
              "ExpenseTextGLD2": "123",
              "ExpenseReportGLD1Label": "Food",
              "ExpenseReportGLD1Name": "Apples and Oranges",
              "ExpenseReportGLD1Code": "A123",
              "ReceiptImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C",
              "ReceiptID": "a3cf5744-92f1-49d6-b8c9-7657b1d90631",
              "PaymentCardName": "Company Visa",
              "CCLast": "0005"
        },
        {
              "ID": "e373a213-1dd3-4e3d-83b7-786bd9a5e201",
              "ExpenseReportID": "9b7146b0-3e92-4745-babf-8bda8973238a",
              "FirstName": "Robbie",
              "LastName": "The Robot",
              "Email": "rrobot@certify.com",
              "EmployeeID": "rrobot002",
              "DepartmentName": "Marketing",
              "DepartmentCode": "02",
              "ExpenseType": "Travel",
              "ExpenseCategory": Airfare",
              "ExpenseCategoryGLCode": "01",
              "Amount": 150.0000,
              "Billable": false,
              "Reimbursable": false,
              "ReimAmount": 0.0000,
              "SubmittedAmount": 0.0000,
              "ExpenseDate": "2016-06-22"
              "PostingDate": ""
              "Vendor": "Delta",
              "ProcessedDate": "2016-06-22",
              "Processed": true,
              "Currency": "USD",
              "SubmittedCurrency": "",
              "Reason": "Airfare",
              "VATAmount": 0.0000,
              "HSTAmount": 0.0000,
              "PSTAmount": 0.0000,
              "ExpenseTextGLD1Label": "Text GLD Expense",
              "ExpenseTextGLD1": "Marketing Convention",
              "ExpenseTextGLD2Label": "Numbers Only GLD",
              "ExpenseReportGLD1Label": "Food",
              "ExpenseReportGLD1Name": "Surf and Turf",
              "ExpenseReportGLD1Code": "st001",
              "TravelFrom": "PWM",
              "TravelTo": "BOS",
              "ReceiptImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"
              "ReceiptID": "b4df5744-92f1-49d6-b8c9-7657b1d90631",
              "PaymentCardName": "Company Mastercard",    
              "CCLast": "0005"           
    }]
}
    
<Expenses>
    <Expense>
      <ID>b65455e0-89d5-4910-82bf-cadfbf5c4126</ID>
      <ExpenseReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</ExpenseReportID>
      <FirstName>Jack</FirstName>
      <LastName>Certi</LastName>
      <Email>jcerti@certify.com</Email>
      <EmployeeID>jcerti001</EmployeeID>
      <DepartmentName>General</DepartmentName>
      <DepartmentCode>01</DepartmentCode>
      <ExpenseType>Lodging</ExpenseType>
      <ExpenseCategory>Lodging</ExpenseCategory>
      <ExpenseCategoryGLCode>03</ExpenseCategoryGLCode>
      <Amount>192.9300</Amount>
      <Billable>false</Billable>
      <Reimbursable>true</Reimbursable>
      <ReimAmount>191.9600</ReimAmount>
      <SubmittedAmount>0.0000</SubmittedAmount>
      <ExpenseDate>2016-05-03</ExpenseDate>
      <PostingDate></PostingDate>
      <Vendor>Mountain View Hotel</Vendor>
      <Location>Mountain View, CA</Location>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <Currency>USD</Currency>
      <SubmittedCurrency></SubmittedCurrency>
      <Reason>Hotel stay</Reason>
      <VATAmount>0.0000</VATAmount>
      <HSTAmount>0.0000</HSTAmount>
      <PSTAmount>0.0000</PSTAmount>
      <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
      <ExpenseTextGLD1>business</ExpenseTextGLD1>
      <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
      <ExpenseTextGLD2>123</ExpenseTextGLD2>
      <ExpenseTextGLD3Label />
      <ExpenseTextGLD3 />
      <ExpenseTextGLD4Label />
      <ExpenseTextGLD4 />
      <ExpenseTextGLD5Label />
      <ExpenseTextGLD5 />
      <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
      <ExpenseReportGLD1Name>Apples and Oranges</ExpenseReportGLD1Name>
      <ExpenseReportGLD1Code>A123</ExpenseReportGLD1Code>
      <ExpenseReportGLD2Label />
      <ExpenseReportGLD2Name />
      <ExpenseReportGLD2Code />
      <ExpenseReportGLD3Label />
      <ExpenseReportGLD3Name />
      <ExpenseReportGLD3Code />
      <ExpenseReportGLD4Label />
      <ExpenseReportGLD4Name />
      <ExpenseReportGLD4Code />
      <ExpenseReportGLD5Label />
      <ExpenseReportGLD5Name />
      <ExpenseReportGLD5Code />
      <TravelFrom />
      <TravelTo />
      <ReceiptImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</ReceiptImageLink>
      <ReceiptID>a3cf5744-92f1-49d6-b8c9-7657b1d90631</ReceiptID>
      <PaymentCardName>Company Visa</PaymentCardName>
      <CCLast>0005</CCLast>
    </Expense>
    <Expense>
      <ID>e373a213-1dd3-4e3d-83b7-566bd9a5e201</ID>
      <ExpenseReportID>9b7146b0-3e92-4745-babf-8bda3273238a</ExpenseReportID>
      <FirstName>Robbie</FirstName>
      <LastName>The Robot</LastName>
      <Email>rrobot@certify.com</Email>
      <EmployeeID>rrobot002</EmployeeID>
      <DepartmentName>Marketing</DepartmentName>
      <DepartmentCode>02</DepartmentCode>
      <ExpenseType>Travel</ExpenseType>
      <ExpenseCategory>Airfare</ExpenseCategory>
      <ExpenseCategoryGLCode>01</ExpenseCategoryGLCode>
      <Amount>150.0000</Amount>
      <Billable>false</Billable>
      <Reimbursable>false</Reimbursable>
      <ReimAmount>0.0000</ReimAmount>
      <SubmittedAmount>0.0000</SubmittedAmount>
      <ExpenseDate>2016-06-22</ExpenseDate>
      <PostingDate></PostingDate>
      <Vendor>Delta</Vendor>
      <ProcessedDate>2016-06-22</ProcessedDate>
      <Processed>true</Processed>
      <Currency>USD</Currency>
      <SubmittedCurrency></SubmittedCurrency>
      <Reason />
      <VATAmount>0.0000</VATAmount>
      <HSTAmount>0.0000</HSTAmount>
      <PSTAmount>0.0000</PSTAmount>
      <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
      <ExpenseTextGLD1>Marketing Convention</ExpenseTextGLD1>
      <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
      <ExpenseTextGLD2 />
      <ExpenseTextGLD3Label />
      <ExpenseTextGLD3 />
      <ExpenseTextGLD4Label />
      <ExpenseTextGLD4 />
      <ExpenseTextGLD5Label />
      <ExpenseTextGLD5 />
      <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
      <ExpenseReportGLD1Name>Surf and Turf</ExpenseReportGLD1Name>
      <ExpenseReportGLD1Code>st001</ExpenseReportGLD1Code>
      <ExpenseReportGLD2Label />
      <ExpenseReportGLD2Name />
      <ExpenseReportGLD2Code />
      <ExpenseReportGLD3Label />
      <ExpenseReportGLD3Name />
      <ExpenseReportGLD3Code />
      <ExpenseReportGLD4Label />
      <ExpenseReportGLD4Name />
      <ExpenseReportGLD4Code />
      <ExpenseReportGLD5Label />
      <ExpenseReportGLD5Name />
      <ExpenseReportGLD5Code />
      <TravelFrom>PWM</TravelFrom>
      <TravelTo>BOS</TravelTo>
      <ReceiptImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</ReceiptImageLink>
      <ReceiptID>b4df5744-92f1-49d6-b8c9-7657b1d90631</ReceiptID>
      <PaymentCardName>Company Mastercard</PaymentCardName>
      <CCLast>0005</CCLast>
    </Expense>
  </Expenses>
Field Value Description
ID Unique ID of the expense.
ExpenseReportID Unique ID of the expense report the expense is attached to.
FirstName Property fields of the employee who the expense report belongs to.
LastName
Email
EmployeeID
DepartmentName Name of the department of the expense.
DepartmentCode Code of the department of the expense.
ExpenseType Type of expense (Mileage, Lodging, Meals, etc.).
ExpenseCategory Expense category of the expense.
ExpenseCategoryGLCode GL Code of the expense category of the expense.
Amount Total amount of the expense.
Billable Indicates whether the expense is billable (true/false).
Reimbursable Indicates whether the expense is reimbursable (true/false).
ReimAmount Reimbursable amount of the expense.
Submitted Amount Total amount of the expense as supplied by credit card feed.
ExpenseDate The date of the expense (yyyy-MM-dd).
PostingDate The posting date of the expense as supplied by credit card feed (yyyy-MM-dd).
Vendor The vendor of the expense.
Location The location of the expense.
ProcessedDate The date the expense was processed on, if applicable (yyyy-MM-dd).
Processed Indicates whether the expense has been processed (true/false).
Currency Three letter code of the currency of the expense. ISO 4217 format. Ex: “USD”
SubmittedCurrency Three letter code of the currency of the expense as supplied by credit card feed. ISO 4217 format. Ex: “USD”
Reason The text entered in the reason field of the expense
VATAmount The value-added tax amount of the expense, if applicable.
HSTAmount The harmonized sales tax amount of the expense, if applicable.
PSTAmount The provincial sales tax amount of the expense, if applicable.
ExpenseTextGLD1Label The label of the Expense Level Free-Text General Ledger Dimension 1.
ExpenseTextGLD1 The value of the Expense Level Free-Text General Ledger Dimension 1
ExpenseTextGLD2Label The labels and values of the Expense Level Free-Text General Ledger Dimension 2-5 (see above).
ExpenseTextGLD2
ExpenseTextGLD3Label
ExpenseTextGLD3
ExpenseTextGLD4Label
ExpenseTextGLD4
ExpenseTextGLD5Label
ExpenseTextGLD5
ExpenseReportGLD1Label The label of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD1Name The name of the value of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD1Code The code of the value of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD2Label The labels and values of the Expense Report General Ledger Dimension 2-5 (see above).
ExpenseReportGLD2Name
ExpenseReportGLD2Code
ExpenseReportGLD3Label
ExpenseReportGLD3Name
ExpenseReportGLD3Code
ExpenseReportGLD4Label
ExpenseReportGLD4Name
ExpenseReportGLD4Code
ExpenseReportGLD5Label
ExpenseReportGLD5Name
ExpenseReportGLD5Code
TravelFrom The origin location or code for travel-based expense categories.
TravelTo The destination location or code for travel-based expense categories.
ReceiptImageLink The Certify URL provided to access the receipt image of this expense.
ReceiptID Unique of the receipt.
PaymentCardName The user supplied label of the Payment Card.
CCLast The last 4 digits of the credit card number used to pay for the expense as supplied by credit card feed.
GET
/expenses/{id}
Expand Method
Description

This method returns a specific expense associated with the supplied ID value. This method only returns results from a processed expense report.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Expense Report/Expense ID Yes string
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "Expense": [
        {
              "ID": "b65455e0-89d5-4910-82bf-cadfbf5c4126",
              "ExpenseReportID": "fdf33884-af87-2891-a7d4-3e574ea6be88",
              "FirstName": "Jack",
              "LastName": "Certi",
              "Email": "jcerti@certify.com",
              "EmployeeID": "jcerti001",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "ExpenseType": "Lodging",
              "ExpenseCategory": "Lodging",
              "ExpenseCategoryGLCode": "03",
              "Amount": 192.9300,
              "Billable": false,
              "Reimbursable": true,
              "ReimAmount": 191.9600,
              "SubmittedAmount": 0.0000,
              "ExpenseDate": "2016-05-03",
              "PostingDate": "",
              "Vendor": "Mountain View Hotel",
              "Location": "Mountain View, CA",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "Currency": "USD",
              "SubmittedCurrency": "",
              "Reason": "Hotel Stay",
              "VATAmount": 0.0000,
              "HSTAmount": 0.0000,
              "PSTAmount": 0.0000,
              "ExpenseTextGLD1Label": "Text GLD Expense",
              "ExpenseTextGLD1": "business",
              "ExpenseTextGLD2Label": "Numbers Only GLD",
              "ExpenseTextGLD2": "123",
              "ExpenseReportGLD1Label": "Food",
              "ExpenseReportGLD1Name": "Apples and Oranges",
              "ExpenseReportGLD1Code": "A123",      
              "ReceiptImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C",  
              "ReceiptID": "a3cf5744-92f1-49d6-b8c9-7657b1d90631",
              "PaymentCardName": "Company Visa",
              "CCLast": "0005"
        }]
}
    
<Expenses>
    <Expense>
      <ID>b65455e0-89d5-4910-82bf-cadfbf5c4126</ID>
      <ExpenseReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</ExpenseReportID>
      <FirstName>Jack</FirstName>
      <LastName>Certi</LastName>
      <Email>jcerti@certify.com</Email>
      <EmployeeID>jcerti001</EmployeeID>
      <DepartmentName>General</DepartmentName>
      <DepartmentCode>01</DepartmentCode>
      <ExpenseType>Lodging</ExpenseType>
      <ExpenseCategory>Lodging</ExpenseCategory>
      <ExpenseCategoryGLCode>03</ExpenseCategoryGLCode>
      <Amount>192.9300</Amount>
      <Billable>false</Billable>
      <Reimbursable>true</Reimbursable>
      <ReimAmount>191.9600</ReimAmount>
      <SubmittedAmount>0.0000</SubmittedAmount>
      <ExpenseDate>2016-05-03</ExpenseDate>
      <PostingDate></PostingDate>
      <Vendor>Mountain View Hotel</Vendor>
      <Location>Mountain View, CA</Location>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <Currency>USD</Currency>
      <SubmittedCurrency></SubmittedCurrency>
      <Reason>Hotel stay</Reason>
      <VATAmount>Hotel stay</0.0000>
      <HSTAmount>Hotel stay</0.0000>
      <PSTAmount>Hotel stay</0.0000>
      <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
      <ExpenseTextGLD1>business</ExpenseTextGLD1>
      <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
      <ExpenseTextGLD2>123</ExpenseTextGLD2>
      <ExpenseTextGLD3Label />
      <ExpenseTextGLD3 />
      <ExpenseTextGLD4Label />
      <ExpenseTextGLD4 />
      <ExpenseTextGLD5Label />
      <ExpenseTextGLD5 />
      <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
      <ExpenseReportGLD1Name>Apples and Oranges</ExpenseReportGLD1Name>
      <ExpenseReportGLD1Code>A123</ExpenseReportGLD1Code>
      <ExpenseReportGLD2Label />
      <ExpenseReportGLD2Name />
      <ExpenseReportGLD2Code />
      <ExpenseReportGLD3Label />
      <ExpenseReportGLD3Name />
      <ExpenseReportGLD3Code />
      <ExpenseReportGLD4Label />
      <ExpenseReportGLD4Name />
      <ExpenseReportGLD4Code />
      <ExpenseReportGLD5Label />
      <ExpenseReportGLD5Name />
      <ExpenseReportGLD5Code />
      <TravelFrom />
      <TravelTo />
      <ReceiptImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</ReceiptImageLink>
      <ReceiptID>a3cf5744-92f1-49d6-b8c9-7657b1d90631</ReceiptID>
      <PaymentCardName>Company Visa</PaymentCardName>  
      <CCLast>0005</CCLast>
  </Expense>
</Expenses>
Field Value Description
ID Unique ID of the expense.
ExpenseReportID Unique ID of the expense report the expense is attached to.
FirstName Property fields of the employee who the expense report belongs to.
LastName
Email
EmployeeID
DepartmentName Name of the department of the expense.
DepartmentCode Code of the department of the expense.
ExpenseType Type of expense (Mileage, Lodging, Meals, etc.).
ExpenseCategory Expense category of the expense.
ExpenseCategoryGLCode GL Code of the expense category of the expense.
Amount Total amount of the expense.
Billable Indicates whether the expense is billable (true/false).
Reimbursable Indicates whether the expense is reimbursable (true/false).
ReimAmount Reimbursable amount of the expense.
Submitted Amount Total amount of the expense as supplied by credit card feed.
ExpenseDate The date of the expense (yyyy-MM-dd).
PostingDate The posting date of the expense as supplied by credit card feed (yyyy-MM-dd).
Vendor The vendor of the expense.
Location The location of the expense.
ProcessedDate The date the expense was processed on, if applicable (yyyy-MM-dd).
Processed Indicates whether the expense has been processed (true/false).
Currency Three letter code of the currency of the expense. ISO 4217 format. Ex: “USD”
SubmittedCurrency Three letter code of the currency of the expense as supplied by credit card feed. ISO 4217 format. Ex: “USD”
Reason The text entered in the reason field of the expense
VATAmount The value-added tax amount of the expense, if applicable.
HSTAmount The harmonized sales tax amount of the expense, if applicable.
PSTAmount The provincial sales tax amount of the expense, if applicable.
ExpenseTextGLD1Label The label of the Expense Level Free-Text General Ledger Dimension 1.
ExpenseTextGLD1 The value of the Expense Level Free-Text General Ledger Dimension 1
ExpenseTextGLD2Label The labels and values of the Expense Level Free-Text General Ledger Dimension 2-5 (see above).
ExpenseTextGLD2
ExpenseTextGLD3Label
ExpenseTextGLD3
ExpenseTextGLD4Label
ExpenseTextGLD4
ExpenseTextGLD5Label
ExpenseTextGLD5
ExpenseReportGLD1Label The label of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD1Name The name of the value of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD1Code The code of the value of the Expense Report General Ledger Dimension 1.
ExpenseReportGLD2Label The labels and values of the Expense Report General Ledger Dimension 2-5 (see above).
ExpenseReportGLD2Name
ExpenseReportGLD2Code
ExpenseReportGLD3Label
ExpenseReportGLD3Name
ExpenseReportGLD3Code
ExpenseReportGLD4Label
ExpenseReportGLD4Name
ExpenseReportGLD4Code
ExpenseReportGLD5Label
ExpenseReportGLD5Name
ExpenseReportGLD5Code
TravelFrom The origin location or code for travel-based expense categories.
TravelTo The destination location or code for travel-based expense categories.
ReceiptImageLink The Certify URL provided to access the receipt image of this expense.
ReceiptID Unique of the receipt.
PaymentCardName The user supplied label of the Payment Card.
CCLast The last 4 digits of the credit card number used to pay for the expense as supplied by credit card feed.
GET
/exprptglds/{index}
Expand Method
Description

This method will return a list of one or more expense report GLD records for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Expense report GLD index Yes number
name query Name of expense report GLD No string
code query Expense report GLD code No string
active query Active status No string (1 for active records, 0 for inactive, NULL for all)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "ExpRptGLDs": [
        {
            "ExpRptGLDIndex": 1,
            "ExpRptGLDLabel": "Favorite Food",
            "ID": "3ceef8d9-7284-462e-b54a-8238e737446a",
            "Name": "Chicken Wings",
            "Code": "",
            "Description": "",
            "Data": "",
            "Active": 1
        },
        {
            "ExpRptGLDIndex": 1,
            "ExpRptGLDLabel": "Favorite Food",
            "ID": "df3c742d-91ef-4843-9a87-59a9e9581fe9",
            "Name": "Nachos",
            "Code": "",
            "Description": "",
            "Data": "",
            "Active": 1
        }
    ]
}

<ExpRptGLDs>
    <ExpRptGLD>
        <ExpRptGLDIndex>1</ExpRptGLDIndex>
        <ExpRptGLDLabel>Favorite Food</ExpRptGLDLabel>
        <ID>3ceef8d9-7284-462e-b54a-8238e737446a</ID>
        <Name>Chicken Wings</Name>
        <Code />
        <Description />
        <Data />
        <Active>1</Active>
    </ExpRptGLD>
    <ExpRptGLD>
        <ExpRptGLDIndex>1</ExpRptGLDIndex>
        <ExpRptGLDLabel>Favorite Food</ExpRptGLDLabel>
        <ID>df3c742d-91ef-4843-9a87-59a9e9581fe9</ID>
        <Name>Nachos</Name>
        <Code />
        <Description />
        <Data />
        <Active>1</Active>
    </ExpRptGLD>
</ExpRptGLDs>
Field Value Description
ExpRptGLDIndex The index of the ExpRptGLD requested.
ExpRptGLDLabel The label assigned the ExpRptGLD by the client in Configuration.
ID Unique ID of the expense report GLD.
Name Expense report GLD name.
Code The internal code used to identify the expense report GLD in your organization.
Description The internal description for the expense report GLD.
Data Used to store various internal code values for the expense report GLD
Active The active status of the expense report GLD (1 = active, 0 = inactive)
POST
/exprptglds/{index}
Expand Method
Description

For each expense report GLD element in the POST body, this method will update expense report GLD records for the current company corresponding to the IDs supplied. Any elements where new values were not provided will retain their current value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Expense report GLD index Yes number
ID body Expense report GLD ID Yes string
Name body Expense report GLD name No string
Code body The internal code used to identify the expense report GLD in your organization. No string
Description body The internal description for the expense report GLD. No string
Active body The active status of the expense report GLD (1 = active, 0 = inactive) No string
Example Request
JSON XML 
[
    {
        "ID": "f4f76080-8003-4406-b4b4-f647bb40fa0d",
        "Description": "Meat and vegetarian"
    },
    {
        "ID": "6b2e73ba-af1c-467a-bc04-8ac13e22c423",
        "Code": "RTCHKDP",
        "Description": "with Corn Chips"
    }
]



<ExpRptGLDs>
    <ExpRptGLD>
        <ID>f4f76080-8003-4406-b4b4-f647bb40fa0d</ID>
        <Description>Meat and vegetarian</Description>
    </ExpRptGLD>
    <ExpRptGLD>
        <ID>6b2e73ba-af1c-467a-bc04-8ac13e22c423</ID>
        <Code>RTCHKDP</Code>
        <Description>with Corn Chips</Description>
    </ExpRptGLD>
</ExpRptGLDs>
Response

A separate status should be returned for each record, either "Updated" or "Error" with a detailed error message. HTTP Status should be 200.

Example Response
JSON XML 
[
    {
        "ID": "f4f76080-8003-4406-b4b4-f647bb40fa0d",
        "Status": "Updated",
        "Message": ""
    },
    {
        "ID": "6b2e73ba-af1c-467a-bc04-8ac13e22c423",
        "Status": "Error",
        "Message": "ExpRptGLD2 ID supplied is not valid."
    }
]

<Results>
    <Result>
        <ID>f4f76080-8003-4406-b4b4-f647bb40fa0d</ID>
        <Status>Updated</Status>
        <Message />
    </Result>
    <Result>
        <ID>6b2e73ba-af1c-467a-bc04-8ac13e22c423</ID>
        <Status>Error</Status>
        <Message>ExpRptGLD2 ID supplied is not valid.</Message>
    </Result>
</Results>
Field Value Description
ID Unique ID of the expense report GLD.
Status Returns status of "Updated" or "Error".
Message Detailed message when Status returns an "Error".
PUT
/exprptglds/{index}
Expand Method
Description

This method creates a new expense report GLD record for the current company.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Expense report GLD index Yes number
Name body Expense report GLD name No string
Code body The internal code used to identify the expense report GLD in your organization. No string
Description body The internal description for the expense report GLD. No string
Active body The active status of the expense report GLD (1 = active, 0 = inactive) No string
Example Request
JSON XML 
{
    "Name": "Lasagna",
    "Code": "LSGN",
    "Description": "Meat or vegetarian",
    "Active": 1
}

<ExpRptGLD>
    <Name>Lasagna</Name>
    <Code>LSGN</Code>
    <Description>Meat or vegetarian</Description>
    <Active>1</Active>
</ExpRptGLD>
Response

If successful, this method should return the ID of the new expense report GLD.

Example Response
JSON XML 
{
    "ID": "f4f76080-8003-4406-b4b4-f647bb40fa0d"
}

<ID>f4f76080-8003-4406-b4b4-f647bb40fa0d</ID>
Field Value Description
ID Unique ID of the expense report GLD.
GET
/exprptglds/{index}/{id}
Expand Method
Description

This method returns an expense report GLD record associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
index path Expense report GLD index Yes number
id path Expense report GLD ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "ExpRptGLDs": [
        {
            "ExpRptGLDIndex": 1,
            "ExpRptGLDLabel": "Favorite Food",
            "ID": "3ceef8d9-7284-462e-b54a-8238e737446a",
            "Name": "Chicken Wings",
            "Code": "",
            "Description": "",
            "Data": "",
            "Active": 1
        }
    ]
}


<ExpRptGLDs>
    <ExpRptGLD>
        <ExpRptGLDIndex>1</ExpRptGLDIndex>
        <ExpRptGLDLabel>Favorite Food</ExpRptGLDLabel>
        <ID>3ceef8d9-7284-462e-b54a-8238e737446a</ID>
        <Name>Chicken Wings</Name>
        <Code />
        <Description />
        <Data />
        <Active>1</Active>
    </ExpRptGLD>
</ExpRptGLDs>
Field Value Description
ExpRptGLDIndex The index of the ExpRptGLD requested.
ExpRptGLDLabel The label assigned the ExpRptGLD by the client in Configuration.
ID Unique ID of the expense report GLD.
Name Expense report GLD name.
Code The internal code used to identify the expense report GLD in your organization.
Description The internal description for the expense report GLD.
Data Used to store various internal code values for the expense report GLD
Active The active status of the expense report GLD (1 = active, 0 = inactive)
GET
/invoicereports
Expand Method
Description

This method returns a list of one or more processed invoice reports.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
approvalcode query Approval code of single invoice report. No string
startdate query Starting point for the processed date range. No string (YYYY-MM-DD)
enddate query Ending point for the processed date range. No string (YYYY-MM-DD)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "InvoiceReports": [
        {
              "ID": "fdf32884-af87-4991-a7q4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeID": "jcerti001",
              "TotalAmount": 292.0400,
              "Currency": "USD",
              "ProcessedDate": "2017-02-03",
              "ApprovalCode": 19,
              "StartDate": "2017-01-01",
              "EndDate": "2017-01-31",
              "InvoiceReportName": "Utilities, January 2017",
              "APSyncComplete": true
        },
        {
              "ID": "a9109697-ew08-45f1-9338-994e046a07ed",
              "EmployeeDepartment": "General",
              "FirstName": "Robbie",
              "LastName": "The Robot",
              "EmployeeID": "rrobot002",
              "TotalAmount": 34.4000,
              "Currency": "USD",
              "ProcessedDate": "2016-02-03",
              "ApprovalCode": 23,
              "StartDate": "2017-02-01",
              "EndDate": "2017-02-28",
              "InvoiceReportName": "Office Supplies",
              "APSyncComplete": false
        }]
}
    
<InvoiceReports>
    <ID>fdf32884-af87-49c1-a7q4-3e574ea6be88</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeID>jcerti001</EmployeeID>
    <TotalAmount>292.04</Amount>
    <Currency>USD</Currency>
    <ProcessedDate>2017-02-03</ProcessedDate>
    <ApprovalCode>19</ApprovalCode>
    <StartDate>2017-01-01</StartDate>
    <EndDate>2017-01-31</EndDate>
    <InvoiceReportName>Utilities, January 2017</InvoiceReportName>
    <APSyncComplete>true</APSyncComplete>
</InvoiceReports>
<InvoiceReports>
    <ID>a9109697-ew08-45f1-93b8-994e046a07ed</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <EmployeeID>rrobot002</EmployeeID>
    <TotalAmount>34.40</Amount>
    <Currency>USD</Currency>
    <ProcessedDate>2016-02-03</ProcessedDate>
    <ApprovalCode>23</ApprovalCode>
    <StartDate>2017-02-01</StartDate>
    <EndDate>2017-02-28</EndDate>
    <InvoiceReportName>Office Supplies,February 2017</InvoiceReportName>
    <APSyncComplete>false</APSyncComplete>
</InvoiceReports>
Field Value Description
ID Unique ID of the invoice Report.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeID
TotalAmount Total amount.
Currency Three letter code of the currency of the invoice report. ISO 4217 format.
ProcessedDate Date on which the invoice report was processed. (YYYY-MM-DD)
ApprovalCode Approval code of the invoice report.
StartDate Start date of the invoice report. (YYYY-MM-DD)
EndDate End date of the invoice report. (YYYY-MM-DD)
InvoiceReportName Name of the invoice report.
APSyncComplete Indicates whether the invoice report has been synchronized with a third party AP system. (true/false)
GET
/invoicereports/{id}
Expand Method
Description

This method returns a specific processed invoice report associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Invoice Report/Invoice ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 

                                {
        "InvoiceReports": [
        {
              "ID": "fdf32884-af87-4991-a7q4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeID": "jcerti001",
              "Amount": 292.0400,
              "Currency": "USD",
              "ProcessedDate": "2017-02-03",
              "ApprovalCode": 19,
              "StartDate": "2017-01-01",
              "EndDate": "2017-01-31",
              "InvoiceReportName": "Utilities, January 2017",
              "APSyncComplete": true
        }]
}
 
    
<InvoiceReports>
    <ID>fdf32884-af87-49c1-a7q4-3e574ea6be88</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeID>jcerti001</EmployeeID>
    <Amount>292.04</Amount>
    <Currency>USD</Currency>
    <ProcessedDate>2017-02-03</ProcessedDate>
    <ApprovalCode>19</ApprovalCode>
    <StartDate>2017-01-01</StartDate>
    <EndDate>2017-01-31</EndDate>
    <InvoiceReportName>Utilities, January 2017</InvoiceReportName>
    <APSyncComplete>true</APSyncComplete>
</InvoiceReports>
Field Value Description
ID Unique ID of the invoice Report.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeID
Amount Total amount.
Currency Three letter code of the currency of the invoice report. ISO 4217 format.
ProcessedDate Date on which the invoice report was processed. (YYYY-MM-DD)
ApprovalCode Approval code of the invoice report.
StartDate Start date of the invoice report. (YYYY-MM-DD)
EndDate End date of the invoice report. (YYYY-MM-DD)
InvoiceReportName Name of the invoice report.
APSyncComplete Indicates whether the invoice report has been synchronized with a third party AP system. (true/false)
GET
/invoicereports/{id}/invoices
Expand Method
Description

This method returns all invoices for the processed invoice report associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Invoice Report/Invoice ID Yes string
approvalcode query Approval code of single invoice report. No string
startdate query Starting point for the processed date range. No string (YYYY-MM-DD)
enddate query Ending point for the processed date range. No string (YYYY-MM-DD)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "Invoice": [
        {
              "ID": "b65455e0-89d5-4910-82bf-cadfbf5c4126",
              "InvoiceReportID": "fdf33884-af87-2891-a7d4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeEmail": "jcerti@certify.com",
              "EmployeeID": "jcerti001",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "Category": "Lodging",
              "CategoryGLCode": "03",
              "InvoiceTextGLD1Label": "Text GLD Invoice,
              "InvoiceTextGLD1": "business",
              "InvoiceTextGLD2Label": "Numbers Only GLD",
              "InvoiceTextGLD2": "123",
              "InvoiceReportGLD1Label": "Food",
              "InvoiceReportGLD1Name": "Apples and Oranges",
              "InvoiceReportGLD1Code": "A123"
              "Amount": 192.9300,
              "Currency": "USD",
              "Reason": "Hotel Stay",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "InvoiceDate": "2016-05-03"
              "InvoiceReportName": "Spring Invoices",
              "InvoiceNumber": "123456-789A",
              "VendorName": "Certify",
              "VendorID": "4770FE18-38D8-4183-96D8-E07D0921F5D3",
              "VendorCode": "",
              "VendorAddress1": "20 York St",
              "VendorAddress2": "Suite 201",
              "VendorCity": "Portland",
              "VendorStateProvince": "Maine",
              "VendorPostalCode": "04101",
              "VendorContactName": "Jack Certi",
              "VendorCustomerAccountNumber": "123-456-7890",
              "VendorTaxpayerID: "98-7654321",
              "Vendor1099": false,
        "DueDate": "2016-07-03"
        "PONumber": "867-5309",
        "POName": "Best Purchase Order Ever",
              "InvoiceImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"   
        },
        {
              "ID": "e373a213-1dd3-4e3d-83b7-786bd9a5e201",
              "InvoiceReportID": "9b7146b0-3e92-4745-babf-8bda8973238a",
              "EmployeeDepartment": "General",
              "FirstName": "Robbie",
              "LastName": "The Robot",
              "EmployeeEmail": "rrobot@certify.com",
              "EmployeeID": "rrobot002",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "Category": "Lodging",
              "CategoryGLCode": "03",
              "InvoiceTextGLD1Label": "Text GLD Invoice,
              "InvoiceTextGLD1": "business",
              "InvoiceTextGLD2Label": "Numbers Only GLD",
              "InvoiceTextGLD2": "123",
              "InvoiceReportGLD1Label": "Food",
              "InvoiceReportGLD1Name": "Apples and Oranges",
              "InvoiceReportGLD1Code": "A123"
              "Amount": 342.5500,
              "Currency": "USD",
              "Reason": "Hotel Stay",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "InvoiceDate": "2016-05-03"
              "InvoiceReportName": "Spring Invoices",
              "InvoiceNumber": "123456-789B",
              "VendorName": "Certify",
              "VendorID": "4770FE18-38D8-4183-96D8-E07D0921F5D3",
              "VendorCode": "",
              "VendorAddress1": "20 York St",
              "VendorAddress2": "Suite 201",
              "VendorCity": "Portland",
              "VendorStateProvince": "Maine",
              "VendorPostalCode": "04101",
              "VendorContactName": "Jack Certi",
              "VendorCustomerAccountNumber": "123-456-7890",
              "VendorTaxpayerID: "98-7654321",
              "Vendor1099": false,
        "DueDate": "2016-07-03"
        "PONumber": "867-5310",
        "POName": "2nd Best Purchase Order Ever",
              "InvoiceImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"   
        }]
}
    
<Invoices>
    <Invoice>
      <ID>b65455e0-89d5-4910-82bf-cadfbf5c4126</ID>
      <InvoiceReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</InvoiceReportID>
      <EmployeeDepartment>General</EmployeeDepartment>
      <FirstName>Jack</FirstName>
      <LastName>Certi</LastName>
      <EmployeeEmail>jcerti@certify.com</Email>
      <EmployeeID>jcerti001</EmployeeID>
      <DepartmentName>General</DepartmentName>
      <DepartmentCode>01</DepartmentCode>
      <Category>Lodging</Category>
      <CategoryGLCode>03</CategoryGLCode>
      <InvoiceTextGLD1Label>Text GLD Invoice</InvoiceTextGLD1Label>
      <InvoiceTextGLD1>business</InvoiceTextGLD1>
      <InvoiceTextGLD2Label>Numbers Only GLD</InvoiceTextGLD2Label>
      <InvoiceTextGLD2>123</InvoiceTextGLD2>
      <InvoiceTextGLD3Label />
      <InvoiceTextGLD3 />
      <InvoiceTextGLD4Label />
      <InvoiceTextGLD4 />
      <InvoiceTextGLD5Label />
      <InvoiceTextGLD5 />
      <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
      <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
      <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
      <InvoiceReportGLD2Label />
      <InvoiceReportGLD2Name />
      <InvoiceReportGLD2Code />
      <InvoiceReportGLD3Label />
      <InvoiceReportGLD3Name />
      <InvoiceReportGLD3Code />
      <InvoiceReportGLD4Label />
      <InvoiceReportGLD4Name />
      <InvoiceReportGLD4Code />
      <InvoiceReportGLD5Label />
      <InvoiceReportGLD5Name />
      <InvoiceReportGLD5Code />
      <Amount>192.9300</Amount>
      <Currency>USD</Currency>
      <Reason>Hotel stay</Reason>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <InvoiceDate>2016-05-03</InvoiceDate>
      <InvoiceReportName>Spring Invoices</InvoiceReportName>
      <InvoiceNumber>123456-789A</InvoiceNumber>
      <VendorName>Certify</VendorName>
      <VendorID>4770FE18-38D8-4183-96D8-E07D0921F5D3</VendorID>
      <VendorCode />
      <VendorAddress1>20 York St</VendorAddress1>
      <VendorAddress2>Suite 201</VendorAddress2>
      <VendorCity>Portland</VendorCity>
      <VendorStateProvince>Maine</VendorStateProvince>
      <VendorPostalCode>04101</VendorPostalCode>
      <VendorContactName>Jack Certi</VendorContactName>
      <VendorCustomerAccountNumber>123-456-7890</VendorCustomerAccountNumber>
      <VendorTaxpayerID>98-7654321</VendorTaxpayerID>
      <Vendor1099>false</Vendor1099>
      <DueDate>2016-05-30</DueDate>
      <PONumber>867-5309</PONumber>
      <POName>Best Purchase Order Ever</POName>
      <InvoiceImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</InvoiceImageLink>
    </Invoice>
    <Invoice>
      <ID>e373a213-1dd3-4e3d-83b7-566bd9a5e201</ID>
      <InvoiceReportID>9b7146b0-3e92-4745-babf-8bda3273238a</InvoiceReportID>
      <EmployeeDepartment>General</EmployeeDepartment>
      <FirstName>Robbie</FirstName>
      <LastName>The Robot</LastName>
      <EmployeeEmail>rrobot@certify.com</Email>
      <EmployeeID>rrobot002</EmployeeID>
      <DepartmentName>Marketing</DepartmentName>
      <DepartmentCode>02</DepartmentCode>
      <Category>Lodging</Category>
      <CategoryGLCode>03</CategoryGLCode>
      <InvoiceTextGLD1Label>Text GLD Invoice</InvoiceTextGLD1Label>
      <InvoiceTextGLD1>business</InvoiceTextGLD1>
      <InvoiceTextGLD2Label>Numbers Only GLD</InvoiceTextGLD2Label>
      <InvoiceTextGLD2>123</InvoiceTextGLD2>
      <InvoiceTextGLD3Label />
      <InvoiceTextGLD3 />
      <InvoiceTextGLD4Label />
      <InvoiceTextGLD4 />
      <InvoiceTextGLD5Label />
      <InvoiceTextGLD5 />
      <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
      <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
      <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
      <InvoiceReportGLD2Label />
      <InvoiceReportGLD2Name />
      <InvoiceReportGLD2Code />
      <InvoiceReportGLD3Label />
      <InvoiceReportGLD3Name />
      <InvoiceReportGLD3Code />
      <InvoiceReportGLD4Label />
      <InvoiceReportGLD4Name />
      <InvoiceReportGLD4Code />
      <InvoiceReportGLD5Label />
      <InvoiceReportGLD5Name />
      <InvoiceReportGLD5Code />
      <Amount>342.5500</Amount>
      <Currency>USD</Currency>
      <Reason>Hotel stay</Reason>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <InvoiceDate>2016-05-03</InvoiceDate>
      <InvoiceReportName>Spring Invoices</InvoiceReportName>
      <InvoiceNumber>123456-789B</InvoiceNumber>
      <VendorName>Certify</VendorName>
      <VendorID>4770FE18-38D8-4183-96D8-E07D0921F5D3</VendorID>
      <VendorCode />
      <VendorAddress1>20 York St</VendorAddress1>
      <VendorAddress2>Suite 201</VendorAddress2>
      <VendorCity>Portland</VendorCity>
      <VendorStateProvince>Maine</VendorStateProvince>
      <VendorPostalCode>04101</VendorPostalCode>
      <VendorContactName>Jack Certi</VendorContactName>
      <VendorCustomerAccountNumber>123-456-7890</VendorCustomerAccountNumber>
      <VendorTaxpayerID>98-7654321</VendorTaxpayerID>
      <Vendor1099>false</Vendor1099>
      <DueDate>2016-05-30</DueDate>
      <PONumber>867-5310</PONumber>
      <POName>2nd Best Purchase Order Ever</POName>
      <InvoiceImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</InvoiceImageLink>
    </Invoice>
  </Invoices>
Field Value Description
ID Unique ID of the invoice.
InvoiceReportID Unique ID of the invoice report the invoice is attached to.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeEmail
EmployeeID
DepartmentName Name of the department of the invoice.
DepartmentCode Code of the department of the invoice.
Category Category of the invoice.
CategoryGLCode GL Code of the category of the invoice.
InvoiceTextGLD1Label The label of the Invoice Level Free-Text General Ledger Dimension 1.
InvoiceTextGLD1 The value of the Invoice Level Free-Text General Ledger Dimension 1
InvoiceTextGLD2Label The labels and values of the Invoice Level Free-Text General Ledger Dimension 2-5 (see above).
InvoiceTextGLD2
InvoiceTextGLD3Label
InvoiceTextGLD3
InvoiceTextGLD4Label
InvoiceTextGLD4
InvoiceTextGLD5Label
InvoiceTextGLD5
InvoiceReportGLD1Label The label of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD1Name The name of the value of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD1Code The code of the value of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD2Label The labels and values of the Invoice Report General Ledger Dimension 2-5 (see above).
InvoiceReportGLD2Name
InvoiceReportGLD2Code
InvoiceReportGLD3Label
InvoiceReportGLD3Name
InvoiceReportGLD3Code
InvoiceReportGLD4Label
InvoiceReportGLD4Name
InvoiceReportGLD4Code
InvoiceReportGLD5Label
InvoiceReportGLD5Name
InvoiceReportGLD5Code
Amount Total amount.
Currency Three letter code of the currency of the invoice report. ISO 4217 format.
Reason The text entered in the reason field of the invoice report.
ProcessedDate Date on which the invoice report was processed. (YYYY-MM-DD)
InvoiceDate The date of the invoice. (YYYY-MM-DD)
InvoiceReportName Name of the invoice report.
InvoiceNumber The number supplied on the invoice
VendorName Property fields of the vendor who generated the invoice.
VendorID
VendorCode
VendorAddress1
VendorAddress2
VendorCity
VendorStateProvince
VendorPostalCode
VendorContactName
VendorCustomerAccountNumber
VendorTaxpayerID
Vendor1099
DueDate Invoice due date. (YYYY-MM-DD)
PONumber Invoice purchase order number.
POName Invoice purchase order name.
InvoiceImageLink The Certify URL provided to access the image of this invoice.
GET
/invoices
Expand Method
Description

This method returns a list of one or more invoices. This method only returns results from a processed invoice report.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
startdate query Starting point for the processed date range. No string (YYYY-MM-DD)
enddate query Ending point for the processed date range. No string (YYYY-MM-DD)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "Invoice": [
        {
              "ID": "b65455e0-89d5-4910-82bf-cadfbf5c4126",
              "InvoiceReportID": "fdf33884-af87-2891-a7d4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeEmail": "jcerti@certify.com",
              "EmployeeID": "jcerti001",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "Category": "Lodging",
              "CategoryGLCode": "03",
              "InvoiceTextGLD1Label": "Text GLD Invoice,
              "InvoiceTextGLD1": "business",
              "InvoiceTextGLD2Label": "Numbers Only GLD",
              "InvoiceTextGLD2": "123",
              "InvoiceReportGLD1Label": "Food",
              "InvoiceReportGLD1Name": "Apples and Oranges",
              "InvoiceReportGLD1Code": "A123"
              "Amount": 192.9300,
              "Currency": "USD",
              "Reason": "Hotel Stay",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "InvoiceDate": "2016-05-03"
              "InvoiceReportName": "Spring Invoices",
              "InvoiceNumber": "123456-789A",
              "VendorName": "Certify",
              "VendorID": "4770FE18-38D8-4183-96D8-E07D0921F5D3",
              "VendorCode": "",
              "VendorAddress1": "20 York St",
              "VendorAddress2": "Suite 201",
              "VendorCity": "Portland",
              "VendorStateProvince": "Maine",
              "VendorPostalCode": "04101",
              "VendorContactName": "Jack Certi",
              "VendorCustomerAccountNumber": "123-456-7890",
              "VendorTaxpayerID: "98-7654321",
              "Vendor1099": false,
        "DueDate": "2016-07-03"
        "PONumber": "867-5309",
        "POName": "Best Purchase Order Ever",
              "InvoiceImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"   
        },
        {
              "ID": "e373a213-1dd3-4e3d-83b7-786bd9a5e201",
              "InvoiceReportID": "9b7146b0-3e92-4745-babf-8bda8973238a",
              "EmployeeDepartment": "General",
              "FirstName": "Robbie",
              "LastName": "The Robot",
              "EmployeeEmail": "rrobot@certify.com",
              "EmployeeID": "rrobot002",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "Category": "Lodging",
              "CategoryGLCode": "03",
              "InvoiceTextGLD1Label": "Text GLD Invoice,
              "InvoiceTextGLD1": "business",
              "InvoiceTextGLD2Label": "Numbers Only GLD",
              "InvoiceTextGLD2": "123",
              "InvoiceReportGLD1Label": "Food",
              "InvoiceReportGLD1Name": "Apples and Oranges",
              "InvoiceReportGLD1Code": "A123"
              "Amount": 342.5500,
              "Currency": "USD",
              "Reason": "Hotel Stay",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "InvoiceDate": "2016-05-03"
              "InvoiceReportName": "Spring Invoices",
              "InvoiceNumber": "123456-789B",
              "VendorName": "Certify",
              "VendorID": "4770FE18-38D8-4183-96D8-E07D0921F5D3",
              "VendorCode": "",
              "VendorAddress1": "20 York St",
              "VendorAddress2": "Suite 201",
              "VendorCity": "Portland",
              "VendorStateProvince": "Maine",
              "VendorPostalCode": "04101",
              "VendorContactName": "Jack Certi",
              "VendorCustomerAccountNumber": "123-456-7890",
              "VendorTaxpayerID: "98-7654321",
              "Vendor1099": false,
        "DueDate": "2016-07-03"
        "PONumber": "867-5310",
        "POName": "2nd Best Purchase Order Ever",
              "InvoiceImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"   
        }]
}
    
<Invoices>
    <Invoice>
      <ID>b65455e0-89d5-4910-82bf-cadfbf5c4126</ID>
      <InvoiceReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</InvoiceReportID>
      <EmployeeDepartment>General</EmployeeDepartment>
      <FirstName>Jack</FirstName>
      <LastName>Certi</LastName>
      <EmployeeEmail>jcerti@certify.com</Email>
      <EmployeeID>jcerti001</EmployeeID>
      <DepartmentName>General</DepartmentName>
      <DepartmentCode>01</DepartmentCode>
      <Category>Lodging</Category>
      <CategoryGLCode>03</CategoryGLCode>
      <InvoiceTextGLD1Label>Text GLD Invoice</InvoiceTextGLD1Label>
      <InvoiceTextGLD1>business</InvoiceTextGLD1>
      <InvoiceTextGLD2Label>Numbers Only GLD</InvoiceTextGLD2Label>
      <InvoiceTextGLD2>123</InvoiceTextGLD2>
      <InvoiceTextGLD3Label />
      <InvoiceTextGLD3 />
      <InvoiceTextGLD4Label />
      <InvoiceTextGLD4 />
      <InvoiceTextGLD5Label />
      <InvoiceTextGLD5 />
      <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
      <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
      <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
      <InvoiceReportGLD2Label />
      <InvoiceReportGLD2Name />
      <InvoiceReportGLD2Code />
      <InvoiceReportGLD3Label />
      <InvoiceReportGLD3Name />
      <InvoiceReportGLD3Code />
      <InvoiceReportGLD4Label />
      <InvoiceReportGLD4Name />
      <InvoiceReportGLD4Code />
      <InvoiceReportGLD5Label />
      <InvoiceReportGLD5Name />
      <InvoiceReportGLD5Code />
      <Amount>192.9300</Amount>
      <Currency>USD</Currency>
      <Reason>Hotel stay</Reason>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <InvoiceDate>2016-05-03</InvoiceDate>
      <InvoiceReportName>Spring Invoices</InvoiceReportName>
      <InvoiceNumber>123456-789A</InvoiceNumber>
      <VendorName>Certify</VendorName>
      <VendorID>4770FE18-38D8-4183-96D8-E07D0921F5D3</VendorID>
      <VendorCode />
      <VendorAddress1>20 York St</VendorAddress1>
      <VendorAddress2>Suite 201</VendorAddress2>
      <VendorCity>Portland</VendorCity>
      <VendorStateProvince>Maine</VendorStateProvince>
      <VendorPostalCode>04101</VendorPostalCode>
      <VendorContactName>Jack Certi</VendorContactName>
      <VendorCustomerAccountNumber>123-456-7890</VendorCustomerAccountNumber>
      <VendorTaxpayerID>98-7654321</VendorTaxpayerID>
      <Vendor1099>false</Vendor1099>
      <DueDate>2016-05-30</DueDate>
      <PONumber>867-5309</PONumber>
      <POName>Best Purchase Order Ever</POName>
      <InvoiceImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</InvoiceImageLink>
    </Invoice>
    <Invoice>
      <ID>e373a213-1dd3-4e3d-83b7-566bd9a5e201</ID>
      <InvoiceReportID>9b7146b0-3e92-4745-babf-8bda3273238a</InvoiceReportID>
      <EmployeeDepartment>General</EmployeeDepartment>
      <FirstName>Robbie</FirstName>
      <LastName>The Robot</LastName>
      <EmployeeEmail>rrobot@certify.com</Email>
      <EmployeeID>rrobot002</EmployeeID>
      <DepartmentName>Marketing</DepartmentName>
      <DepartmentCode>02</DepartmentCode>
      <Category>Lodging</Category>
      <CategoryGLCode>03</CategoryGLCode>
      <InvoiceTextGLD1Label>Text GLD Invoice</InvoiceTextGLD1Label>
      <InvoiceTextGLD1>business</InvoiceTextGLD1>
      <InvoiceTextGLD2Label>Numbers Only GLD</InvoiceTextGLD2Label>
      <InvoiceTextGLD2>123</InvoiceTextGLD2>
      <InvoiceTextGLD3Label />
      <InvoiceTextGLD3 />
      <InvoiceTextGLD4Label />
      <InvoiceTextGLD4 />
      <InvoiceTextGLD5Label />
      <InvoiceTextGLD5 />
      <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
      <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
      <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
      <InvoiceReportGLD2Label />
      <InvoiceReportGLD2Name />
      <InvoiceReportGLD2Code />
      <InvoiceReportGLD3Label />
      <InvoiceReportGLD3Name />
      <InvoiceReportGLD3Code />
      <InvoiceReportGLD4Label />
      <InvoiceReportGLD4Name />
      <InvoiceReportGLD4Code />
      <InvoiceReportGLD5Label />
      <InvoiceReportGLD5Name />
      <InvoiceReportGLD5Code />
      <Amount>342.5500</Amount>
      <Currency>USD</Currency>
      <Reason>Hotel stay</Reason>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <InvoiceDate>2016-05-03</InvoiceDate>
      <InvoiceReportName>Spring Invoices</InvoiceReportName>
      <InvoiceNumber>123456-789B</InvoiceNumber>
      <VendorName>Certify</VendorName>
      <VendorID>4770FE18-38D8-4183-96D8-E07D0921F5D3</VendorID>
      <VendorCode />
      <VendorAddress1>20 York St</VendorAddress1>
      <VendorAddress2>Suite 201</VendorAddress2>
      <VendorCity>Portland</VendorCity>
      <VendorStateProvince>Maine</VendorStateProvince>
      <VendorPostalCode>04101</VendorPostalCode>
      <VendorContactName>Jack Certi</VendorContactName>
      <VendorCustomerAccountNumber>123-456-7890</VendorCustomerAccountNumber>
      <VendorTaxpayerID>98-7654321</VendorTaxpayerID>
      <Vendor1099>false</Vendor1099>
      <DueDate>2016-05-30</DueDate>
      <PONumber>867-5310</PONumber>
      <POName>2nd Best Purchase Order Ever</POName>
      <InvoiceImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</InvoiceImageLink>
    </Invoice>
  </Invoices>
Field Value Description
ID Unique ID of the invoice.
InvoiceReportID Unique ID of the invoice report the invoice is attached to.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeEmail
EmployeeID
DepartmentName Name of the department of the invoice.
DepartmentCode Code of the department of the invoice.
Category Category of the invoice.
CategoryGLCode GL Code of the category of the invoice.
InvoiceTextGLD1Label The label of the Invoice Level Free-Text General Ledger Dimension 1.
InvoiceTextGLD1 The value of the Invoice Level Free-Text General Ledger Dimension 1
InvoiceTextGLD2Label The labels and values of the Invoice Level Free-Text General Ledger Dimension 2-5 (see above).
InvoiceTextGLD2
InvoiceTextGLD3Label
InvoiceTextGLD3
InvoiceTextGLD4Label
InvoiceTextGLD4
InvoiceTextGLD5Label
InvoiceTextGLD5
InvoiceReportGLD1Label The label of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD1Name The name of the value of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD1Code The code of the value of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD2Label The labels and values of the Invoice Report General Ledger Dimension 2-5 (see above).
InvoiceReportGLD2Name
InvoiceReportGLD2Code
InvoiceReportGLD3Label
InvoiceReportGLD3Name
InvoiceReportGLD3Code
InvoiceReportGLD4Label
InvoiceReportGLD4Name
InvoiceReportGLD4Code
InvoiceReportGLD5Label
InvoiceReportGLD5Name
InvoiceReportGLD5Code
Amount Total amount.
Currency Three letter code of the currency of the invoice report. ISO 4217 format.
Reason The text entered in the reason field of the invoice report.
ProcessedDate Date on which the invoice report was processed. (YYYY-MM-DD)
InvoiceDate The date of the invoice. (YYYY-MM-DD)
InvoiceReportName Name of the invoice report.
InvoiceNumber The number supplied on the invoice
VendorName Property fields of the vendor who generated the invoice.
VendorID
VendorCode
VendorAddress1
VendorAddress2
VendorCity
VendorStateProvince
VendorPostalCode
VendorContactName
VendorCustomerAccountNumber
VendorTaxpayerID
Vendor1099
DueDate Invoice due date. (YYYY-MM-DD)
PONumber Invoice purchase order number.
POName Invoice purchase order name.
InvoiceImageLink The Certify URL provided to access the image of this invoice.
GET
/invoices/{id}
Expand Method
Description

This method returns a specific processed invoice associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Invoice Report/Invoice ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
        "Invoice": [
        {
              "ID": "b65455e0-89d5-4910-82bf-cadfbf5c4126",
              "InvoiceReportID": "fdf33884-af87-2891-a7d4-3e574ea6be88",
              "EmployeeDepartment": "General",
              "FirstName": "Jack",
              "LastName": "Certi",
              "EmployeeEmail": "jcerti@certify.com",
              "EmployeeID": "jcerti001",
              "DepartmentName": "General",
              "DepartmentCode": "01",
              "Category": "Lodging",
              "CategoryGLCode": "03",
              "InvoiceTextGLD1Label": "Text GLD Invoice,
              "InvoiceTextGLD1": "business",
              "InvoiceTextGLD2Label": "Numbers Only GLD",
              "InvoiceTextGLD2": "123",
              "InvoiceReportGLD1Label": "Food",
              "InvoiceReportGLD1Name": "Apples and Oranges",
              "InvoiceReportGLD1Code": "A123"
              "Amount": 192.9300,
              "Currency": "USD",
              "Reason": "Hotel Stay",
              "ProcessedDate": "2016-05-30",
              "Processed": true,
              "InvoiceDate": "2016-05-03"
              "InvoiceReportName": "Spring Invoices",
              "InvoiceNumber": "123456-789A",
              "VendorName": "Certify",
              "VendorID": "4770FE18-38D8-4183-96D8-E07D0921F5D3",
              "VendorCode": "",
              "VendorAddress1": "20 York St",
              "VendorAddress2": "Suite 201",
              "VendorCity": "Portland",
              "VendorStateProvince": "Maine",
              "VendorPostalCode": "04101",
              "VendorContactName": "Jack Certi",
              "VendorCustomerAccountNumber": "123-456-7890",
              "VendorTaxpayerID: "98-7654321",
              "Vendor1099": false,
        "DueDate": "2016-07-03"
        "PONumber": "867-5309",
        "POName": "Best Purchase Order Ever",
              "InvoiceImageLink": "https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60688D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C"   
        }]
}
    
<Invoices>
    <Invoice>
      <ID>b65455e0-89d5-4910-82bf-cadfbf5c4126</ID>
      <InvoiceReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</InvoiceReportID>
      <EmployeeDepartment>General</EmployeeDepartment>
      <FirstName>Jack</FirstName>
      <LastName>Certi</LastName>
      <EmployeeEmail>jcerti@certify.com</Email>
      <EmployeeID>jcerti001</EmployeeID>
      <DepartmentName>General</DepartmentName>
      <DepartmentCode>01</DepartmentCode>
      <Category>Lodging</Category>
      <CategoryGLCode>03</CategoryGLCode>
      <InvoiceTextGLD1Label>Text GLD Invoice</InvoiceTextGLD1Label>
      <InvoiceTextGLD1>business</InvoiceTextGLD1>
      <InvoiceTextGLD2Label>Numbers Only GLD</InvoiceTextGLD2Label>
      <InvoiceTextGLD2>123</InvoiceTextGLD2>
      <InvoiceTextGLD3Label />
      <InvoiceTextGLD3 />
      <InvoiceTextGLD4Label />
      <InvoiceTextGLD4 />
      <InvoiceTextGLD5Label />
      <InvoiceTextGLD5 />
      <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
      <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
      <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
      <InvoiceReportGLD2Label />
      <InvoiceReportGLD2Name />
      <InvoiceReportGLD2Code />
      <InvoiceReportGLD3Label />
      <InvoiceReportGLD3Name />
      <InvoiceReportGLD3Code />
      <InvoiceReportGLD4Label />
      <InvoiceReportGLD4Name />
      <InvoiceReportGLD4Code />
      <InvoiceReportGLD5Label />
      <InvoiceReportGLD5Name />
      <InvoiceReportGLD5Code />
      <Amount>192.9300</Amount>
      <Currency>USD</Currency>
      <Reason>Hotel stay</Reason>
      <ProcessedDate>2016-05-30</ProcessedDate>
      <Processed>true</Processed>
      <InvoiceDate>2016-05-03</InvoiceDate>
      <InvoiceReportName>Spring Invoices</InvoiceReportName>
      <InvoiceNumber>123456-789A</InvoiceNumber>
      <VendorName>Certify</VendorName>
      <VendorID>4770FE18-38D8-4183-96D8-E07D0921F5D3</VendorID>
      <VendorCode />
      <VendorAddress1>20 York St</VendorAddress1>
      <VendorAddress2>Suite 201</VendorAddress2>
      <VendorCity>Portland</VendorCity>
      <VendorStateProvince>Maine</VendorStateProvince>
      <VendorPostalCode>04101</VendorPostalCode>
      <VendorContactName>Jack Certi</VendorContactName>
      <VendorCustomerAccountNumber>123-456-7890</VendorCustomerAccountNumber>
      <VendorTaxpayerID>98-7654321</VendorTaxpayerID>
      <Vendor1099>false</Vendor1099>
      <DueDate>2016-05-30</DueDate>
      <PONumber>867-5309</PONumber>
      <POName>Best Purchase Order Ever</POName>
      <InvoiceImageLink>https://www.certify.com/ReceiptImage.aspx?receiptID=AECCC911C7B60618D6A0C39565A2224EBD&th=6E84D13C4EA482A5CC2A28F85A23F43C</InvoiceImageLink>
    </Invoice>
</Invoices>
Field Value Description
ID Unique ID of the invoice.
InvoiceReportID Unique ID of the invoice report the invoice is attached to.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeEmail
EmployeeID
DepartmentName Name of the department of the invoice.
DepartmentCode Code of the department of the invoice.
Category Category of the invoice.
CategoryGLCode GL Code of the category of the invoice.
InvoiceTextGLD1Label The label of the Invoice Level Free-Text General Ledger Dimension 1.
InvoiceTextGLD1 The value of the Invoice Level Free-Text General Ledger Dimension 1
InvoiceTextGLD2Label The labels and values of the Invoice Level Free-Text General Ledger Dimension 2-5 (see above).
InvoiceTextGLD2
InvoiceTextGLD3Label
InvoiceTextGLD3
InvoiceTextGLD4Label
InvoiceTextGLD4
InvoiceTextGLD5Label
InvoiceTextGLD5
InvoiceReportGLD1Label The label of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD1Name The name of the value of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD1Code The code of the value of the Invoice Report General Ledger Dimension 1.
InvoiceReportGLD2Label The labels and values of the Invoice Report General Ledger Dimension 2-5 (see above).
InvoiceReportGLD2Name
InvoiceReportGLD2Code
InvoiceReportGLD3Label
InvoiceReportGLD3Name
InvoiceReportGLD3Code
InvoiceReportGLD4Label
InvoiceReportGLD4Name
InvoiceReportGLD4Code
InvoiceReportGLD5Label
InvoiceReportGLD5Name
InvoiceReportGLD5Code
Amount Total amount.
Currency Three letter code of the currency of the invoice report. ISO 4217 format.
Reason The text entered in the reason field of the invoice report.
ProcessedDate Date on which the invoice report was processed. (YYYY-MM-DD)
InvoiceDate The date of the invoice. (YYYY-MM-DD)
InvoiceReportName Name of the invoice report.
InvoiceNumber The number supplied on the invoice
VendorName Property fields of the vendor who generated the invoice.
VendorID
VendorCode
VendorAddress1
VendorAddress2
VendorCity
VendorStateProvince
VendorPostalCode
VendorContactName
VendorCustomerAccountNumber
VendorTaxpayerID
Vendor1099
DueDate Invoice due date. (YYYY-MM-DD)
PONumber Invoice purchase order number.
POName Invoice purchase order name.
InvoiceImageLink The Certify URL provided to access the image of this invoice.
GET
/receipts
Expand Method
Description

This method returns a list of metadata from one or more receipts from a processed expense report.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
expid query Filter receipts returned to a specific Expense ID No string
exprptid query Filter receipts returned to a specific Expense Report ID No string
startdate query Starting point for the expense date range. No string (YYYY-MM-DD)
enddate query Ending point for the expense date range. No string (YYYY-MM-DD)
batchid query Filter receipts returned to a specific Batch ID No string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "Receipts": [
    {
        "ID": "f86663bd-00b2-495c-ad77-2b6af37895aa",
        "Filename": "image.jpg",
        "UploadDate": "2017-04-03"
    },
    {
        "ID": "03fa573c-b7f0-4398-b329-9f39a03dfb55",
        "Filename": "image2.jpg",
        "UploadDate": "2017-04-03"
    }]
}

<Receipts>
    <Receipt>
    <ID>f86663bd-00b2-495c-ad77-2b6af37895aa</ID>
    <Filename>image.jpg</Filename>
    <UploadDate>2017-04-03</UploadDate>
  </Receipt>
    <Receipt>
    <ID>03fa573c-b7f0-4398-b329-9f39a03dfb55</ID>
    <Filename>image2.jpg</Filename>
    <UploadDate>2017-04-03</UploadDate>
  </Receipt>
</Receipts>
Field Value Description
ID Unique ID of the receipt.
Filename Filename of the receipt.
UploadDate Date the receipt was uploaded to the wallet.
GET
/receipts/{id}
Expand Method
Description

This method returns one receipt from a processed expense report.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path Receipt ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 
{
    "Receipt": [
    {
        "ID": "f86663bd-00b2-495c-ad77-2b6af37895aa",
        "Filename": "image.jpg",
        "UploadDate": "2017-04-03",
        "ReceiptImage": "/9j/4AAQSkZJRgABAQAAAQABAAD..."
    }
}


  <Receipt>
    <ID>f86663bd-00b2-495c-ad77-2b6af37895aa</ID>
    <Filename>image.jpg</Filename>
    <UploadDate>2017-04-03</UploadDate>
    <ReceiptImage>/9j/4AAQSkZJRgABAQAAAQABAAD...;/ReceiptImage>
  </Receipt>
Field Value Description
ID Unique ID of the receipt.
Filename Filename of the receipt.
UploadDate Date the receipt was uploaded to the wallet.
ReceiptImage Base-64 encoded string of the image data.
GET
/users
Expand Method
Description

This method will return a list of one or more users.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
username query User name (email address) No string
active query Active status No string string (1 for active records, 0 for inactive, NULL for all)
role query Role name No string (‘Accountants’, ‘Employees’, ‘Executives’, ‘Guests’, ‘Managers’)
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 

{
    "Users": [
    {
        "ID": "fc12bf3a-766e-4ec3-b2ae-60f2efe9505d",
        "UserName": "johnsmith@circp.com",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "johnsmith@circp.com",
        "EmployeeID": "JSMITH002",
        "MobilePhone": "2075551212",
        "Role": "Accountants",
        "Treasurer": 1,
        "FullAdministrator": 1,
        "UserAdministrator": 0,
        "DepartmentID": "c456ab38-8f74-49e2-a47b-178f72c2f45f",
        "EmpGLD1ID": "2ea4ee07-7706-4a1e-a8f8-f56ea48487d0",
        "EmpGLD2ID": "",
        "EmpGLD3ID": "",
        "EmpGLD4ID": "",
        "EmpGLD5ID": "",
        "Culture": "en-US",
        "Language": "en",
        "Currency": "USD",
        "LastModifiedDate": "2017-8-10",
        "Active": 1
    },
    {
        "ID": "967ab3a2-f389-4ee4-a51b-772d95fa9fbc",
        "UserName": "daviddoe@circp.com",
        "FirstName": "David",
        "LastName": "Doe",
        "Email": "daviddoe@circp.com",
        "EmployeeID": "DDOE001",
        "MobilePhone": "",
        "Role": "Employees",
        "Treasurer": 0,
        "FullAdministrator": 0,
        "UserAdministrator": 1,
        "DepartmentID": "c456ab38-8f74-49e2-a47b-178f72c2f45f",
        "EmpGLD1ID": "",
        "EmpGLD2ID": "",
        "EmpGLD3ID": "",
        "EmpGLD4ID": "",
        "EmpGLD5ID": "",
        "Culture": "en-US",
        "Language": "en",
        "Currency": "USD",
        "LastModifiedDate": "2018-7-21",
        "Active": 1
    }
    ]
}


<Users>
    <User>
        <ID>fc12bf3a-766e-4ec3-b2ae-60f2efe9505d</ID>
        <UserName>johnsmith@circp.com</UserName>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Email>johnsmith@circp.com</Email>
        <EmployeeID>JSMITH002</EmployeeID>
        <MobilePhone>2075551212</MobilePhone>
        <Role>Accountants</Role>
        <Treasurer>1</Treasurer>
        <FullAdministrator>1</FullAdministrator>
        <UserAdministrator>0</UserAdministrator>
        <DepartmentID>c456ab38-8f74-49e2-a47b-178f72c2f45f</DepartmentID>
        <EmpGLD1ID>2ea4ee07-7706-4a1e-a8f8-f56ea48487d0<EmpGLD1ID>
        <EmpGLD2ID />
        <EmpGLD3ID />
        <EmpGLD4ID />
        <EmpGLD5ID />
        <Culture>en-US</Culture>
        <Language>en</Language>
        <Currency>USD</Currency>
        <LastModifiedDate>2017-8-10</LastModifiedDate>
        <Active>1</Active>
    </User>
    <User>
        <ID>967ab3a2-f389-4ee4-a51b-772d95fa9fbc</ID>
        <UserName>daviddoe@circp.com</UserName>
        <FirstName>David</FirstName>
        <LastName>Doe</LastName>
        <Email>daviddoe@circp.com</Email>
        <EmployeeID>DDOE001</EmployeeID>
        <MobilePhone />
        <Role>Employees</Role>
        <Treasurer>0</Treasurer>
        <FullAdministrator>0</FullAdministrator>
        <UserAdministrator>1</UserAdministrator>
        <DepartmentID>c456ab38-8f74-49e2-a47b-178f72c2f45f</DepartmentID>
        <EmpGLD1ID />
        <EmpGLD2ID />
        <EmpGLD3ID />
        <EmpGLD4ID />
        <EmpGLD5ID />
        <Culture>en-US</Culture>
        <Language>en</Language>
        <Currency>USD</Currency>
        <LastModifiedDate>2018-7-21</LastModifiedDate>
        <Active>1</Active>
    </User>
</Users>;
Field Value Description
ID Unique ID of the user
UserName Login name of the user
FirstName First name of the user
LastName Last name of the user
Email Email address of the user
EmployeeID User employee ID
MobilePhone User mobile phone number
Role User access role (‘Accountants’, ‘Employees’, ‘Executives’, ‘Guests’, ‘Managers’)
Treasurer Indicates whether or not the user is a Treasurer (1 = yes, 0 = no)
FullAdministrator User has access to all settings in the Configuration tab (1 = yes, 0 = no)
UserAdministrator User has access to view/edit user profiles in the Configuration tab; cannot use the "Switch to this User" function (1 = yes, 0 = no)
DepartmentID Department ID for the user
EmpGLD1ID Employee GLD1 ID for the user
EmpGLD2ID Employee GLD2 ID for the user
EmpGLD3ID Employee GLD3 ID for the user
EmpGLD4ID Employee GLD4 ID for the user
EmpGLD5ID Employee GLD5 ID for the user
Culture User culture ISO code (ie: ‘en-US’)
Language User two-character ISO language code (ie: ‘de’)
Currency User three-character ISO currency code (ie: ‘USD’)
LastModifiedDate Date the user was last update (YYYY-MM-DD)
Active The active status of the user (1 = active, 0 = inactive)
GET
/users/{id}
Expand Method
Description

This method should return a specific user associated with the supplied ID value.

Parameters
Name Located in Description Required Schema
x-api-key header API Key (see Authentication) Yes string
x-api-secret header API Secret (see Authentication) Yes string
id path User ID Yes string
Responses
Code Description
200 Success
400 One or more parameters is badly formatted. See specific error message for details.
401 Invalid API credentials or credentials were not supplied.
Example Response
JSON XML 

{
    "User": [
    {
        "ID": "fc12bf3a-766e-4ec3-b2ae-60f2efe9505d",
        "UserName": "johnsmith@circp.com",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "johnsmith@circp.com",
        "EmployeeID": "JSMITH002",
        "MobilePhone": "2075551212",
        "Role": "Accountants",
        "Treasurer": 1,
        "FullAdministrator": 1,
        "UserAdministrator": 0,
        "DepartmentID": "c456ab38-8f74-49e2-a47b-178f72c2f45f",
        "EmpGLD1ID": "2ea4ee07-7706-4a1e-a8f8-f56ea48487d0",
        "EmpGLD2ID": "",
        "EmpGLD3ID": "",
        "EmpGLD4ID": "",
        "EmpGLD5ID": "",
        "Culture": "en-US",
        "Language": "en",
        "Currency": "USD",
        "LastModifiedDate": "2017-8-10",
        "Active": 1
    }
    ]
}


<Users>
    <User>
        <ID>fc12bf3a-766e-4ec3-b2ae-60f2efe9505d</ID>
        <UserName>johnsmith@circp.com</UserName>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Email>johnsmith@circp.com</Email>
        <EmployeeID>JSMITH002</EmployeeID>
        <MobilePhone>2075551212</MobilePhone>
        <Role>Accountants</Role>
        <Treasurer>1</Treasurer>
        <FullAdministrator>1</FullAdministrator>
        <UserAdministrator>0</UserAdministrator>
        <DepartmentID>c456ab38-8f74-49e2-a47b-178f72c2f45f</DepartmentID>
        <EmpGLD1ID>2ea4ee07-7706-4a1e-a8f8-f56ea48487d0<EmpGLD1ID>
        <EmpGLD2ID />
        <EmpGLD3ID />
        <EmpGLD4ID />
        <EmpGLD5ID />
        <Culture>en-US</Culture>
        <Language>en</Language>
        <Currency>USD</Currency>
        <LastModifiedDate>2017-8-10</LastModifiedDate>
        <Active>1</Active>
    </User>
</Users>
Field Value Description
ID Unique ID of the user
UserName Login name of the user
FirstName First name of the user
LastName Last name of the user
Email Email address of the user
EmployeeID User employee ID
MobilePhone User mobile phone number
Role User access role (‘Accountants’, ‘Employees’, ‘Executives’, ‘Guests’, ‘Managers’)
Treasurer Indicates whether or not the user is a Treasurer (1 = yes, 0 = no)
FullAdministrator User has access to all settings in the Configuration tab (1 = yes, 0 = no)
UserAdministrator User has access to view/edit user profiles in the Configuration tab; cannot use the "Switch to this User" function (1 = yes, 0 = no)
DepartmentID Department ID for the user
EmpGLD1ID Employee GLD1 ID for the user
EmpGLD2ID Employee GLD2 ID for the user
EmpGLD3ID Employee GLD3 ID for the user
EmpGLD4ID Employee GLD4 ID for the user
EmpGLD5ID Employee GLD5 ID for the user
Culture User culture ISO code (ie: ‘en-US’)
Language User two-character ISO language code (ie: ‘de’)
Currency User three-character ISO currency code (ie: ‘USD’)
LastModifiedDate Date the user was last update (YYYY-MM-DD)
Active The active status of the user (1 = active, 0 = inactive)