skipToMainContent

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/

For instructions on how to create API credentials, see here.


Have feedback about the Certify API?
Drop an email to certifyapifeedback@emburse.com!

REST

The Certify API uses standard RESTful API calls via HTTP web requests with methods like GET, POST, and PUT. 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.
Pagination

The following API methods support pagination:

  • GET /cpdlists
  • GET /departments
  • GET /empglds
  • GET /expensecategories
  • GET /expensereports
  • GET /expenses
  • GET /exprptglds
  • GET /invoicereports
  • GET /invoices
  • GET /mileagerates
  • GET /mileageratedetails
  • GET /receipts
  • GET /users
  • GET /settlementaccounts

Note: For all other methods, there is a maximum limit of 1,000 records returned. If the request returns more than the limit, it must be narrowed down using the filter parameters of the method.

Pagination is automatically enabled for the above methods.
The max number of results per page is 1,000.

Example Paginated Response
JSON XML
{
                                    "Page": 1,
                                    "PageCount": 8,
                                    "Records": 10,
                                    "RecordCount": 74,
                                    "ExpenseCategories": [
                                        {
                                            "ff4484da-6847-4617-bc2d-d1150878a15a",
                                            ...
                                        }
                                    ]
                                    }
                                    
<ExpenseCategories Page="1" PageCount="1" Records="74" RecordCount="74">
                                    <ExpenseCategory>
                                        <ID>ff4484da-6847-4617-bc2d-d1150878a15a</ID>
                                        ...
                                    </ExpenseCategory>
                                    </ExpenseCategories>
Field Value Description
Page Current page being returned.
PageCount Total number of pages.
Records Number of records on current page.
RecordCount Total number or records.
Optimized Data Handling for Large Datasets

Our API is designed to efficiently handle large datasets, ensuring optimal performance. To achieve this, certain endpoints incorporate a caching mechanism when the number of records returned exceeds 1,000.

To maintain data accuracy, cached results are automatically cleared after 15 minutes. This ensures that you always receive up-to-date information. If you're not seeing newly created records due to caching, you can purge the cache before the 15-minute mark by providing the parameter clearcache in your request with the value of 1. This will clear the cache immediately.

Note: Using caching helps speed up response times for endpoints with large datasets. However, frequent cache invalidation may impact performance. Use the custom clearance option judiciously to balance performance and data freshness.

The following API methods support caching results:

  • GET /departments
  • GET /empglds
  • GET /expensereports
  • GET /expenses
  • GET /exprptglds
  • GET /users

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)
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
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": "Corporate Sales",
      "Description": "New list specifically for Corp Sales",
      "Data": "",
      "Active": 1
    },
    {
      "ID": "9ea702a7-fe30-412c-81e5-ff4d04ead3ab",
      "Name": "Sales",
      "Description": "",
      "Data": "",
      "Active": 1
    }
  ]
<CPDLists>
  <CPDList>
    <ID>82480202-c661-4afe-b36d-c8d97865a339</ID>
    <Name>Corporate Sales</Name>
    <Description>New list specifically for Corp Sales</Description>
    <Data />
    <Active>1</Active>
  </CPDList>
  <CPDList>
    <ID>9ea702a7-fe30-412c-81e5-ff4d04ead3ab</ID>
    <Name>Sales</Name>
    <Description />
    <Data />
    <Active>1</Active>
  </CPDList>
</CPDLists>
Fields
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": "Corporate Sales",
      "Description": "New list specifically for Corp Sales",
      "Data": "",
      "Active": 1
    }
<CPDLists>
  <CPDList>
    <ID>82480202-c661-4afe-b36d-c8d97865a339</ID>
    <Name>Corporate Sales</Name>
    <Description>New list specifically for Corp Sales</Description>
    <Data />
    <Active>1</Active>
  </CPDList>
</CPDLists>
Fields
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)
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
clearcache query For improved efficiency, this endpoint caches results for 15 minutes. Include this parameter to refresh the cache and obtain updated values instantly. No string (1 to clear cache)
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>
Fields
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 (Max Length: 255) No string
Code body The internal code used to identify the department in your organization. (Max Length: 255) No string
Description body The internal description for the department. (Max Length: 2000) No string
Data body Used to store various internal code values 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
Example Request
JSON XML
 [
    {
      "ID": "49c6743a-2f4c-4bb4-8092-ab724c92baf2",
      "Name": "Test Department",
      "Code": "01",
      "Description": "Updated description 1",
      "Data": "",
      "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>
    <Data />
    <ObtainSecondLevelApproval>0</ObtainSecondLevelApproval>
    <UseStrictFiltering>0</UseStrictFiltering>
    <HideDepartment>0</HideDepartment>
    <HideBillable>0</HideBillable>
    <HideBillableDefaultValue>0</HideBillableDefaultValue>
    <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>
    <HideDepartment>0</HideDepartment>
    <HideBillable>0</HideBillable>
    <HideBillableDefaultValue>0</HideBillableDefaultValue>
    <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>
Fields
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 (Max Length: 255) No string
Code body The internal code used to identify the department in your organization. (Max Length: 255) No string
Description body The internal description for the department. (Max Length: 2000) No string
Data body Used to store various internal code values 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": "",
      "D": "a",
      "UseStrictFiltering": 0,
      "HideDepartment": 0,
      "HideBillable": 0,
      "HideBillableDefaultValue": 0,
      "HideReimbursable": 0,
      "HideReimbursableDefaultValue": 1,
      "InitialPage": 0
    }
<Departments>
  <Department>
    <Name>Test Department</Name>
    <Code>01</Code>
    <Description />
    <D>a</D>
    <UseStrictFiltering>0</UseStrictFiltering>
    <HideDepartment>0</HideDepartment>
    <HideBillable>0</HideBillable>
    <HideBillableDefaultValue>0</HideBillableDefaultValue>
    <HideReimbursable>0</HideReimbursable>
    <HideReimbursableDefaultValue>1</HideReimbursableDefaultValue>
    <InitialPage>0</InitialPage>
  </Department>
</Departments>
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>
Fields
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
{
   "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
    }
<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>
Fields
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)
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
clearcache query For improved efficiency, this endpoint caches results for 15 minutes. Include this parameter to refresh the cache and obtain updated values instantly. No string (1 to clear cache)
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>
Fields
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 (Max Length: 255) No string
Code body The internal code used to identify the employee GLD in your organization. (Max Length: 255) No string
Description body The internal description for the employee GLD. (Max Length: 2000) No string
Data body Used to store various internal code values 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",
      "Data": ""
    },
    {
      "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>
    <Data />
  </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>
Fields
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 (Max Length: 255) Yes string
Code body The internal code used to identify the employee GLD in your organization. (Max Length: 255) No string
Description body The internal description for the employee GLD. (Max Length: 2000) No string
Data body Used to store various internal code values 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",
    "Data": "",
    "Active": 1
  }

<EmpGLD>
  <Name>Lasagna</Name>
  <Code>LSGN</Code>
  <Description>Meat or vegetarian</Description>
  <Data />
  <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>
Fields
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>
Fields
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)
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
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.
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
{
   "ExpenseCategories": [
    {
      "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e",
      "Name": "Sales & Marketing:6032",
      "Description": "",
      "Data": "",
      "ExpenseTypeID": 1,
      "MaxAmount": 0,
      "MaxAmountCurrencyType": "USD",
      "SpendLimitPerUser": 1000,
      "SpendLimitPerUserCurrencyType": "USD",
      "SpendLimitPerUserTerm": "Quarterly",
      "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",
      "SpendLimitPerUser": 0,
      "SpendLimitPerUserCurrencyType": "",
      "SpendLimitPerUserTerm": "",
      "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</MaxAmount>
    <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
    <SpendLimitPerUser>1000</SpendLimitPerUser>
    <SpendLimitPerUserCurrencyType>USD</SpendLimitPerUserCurrencyType>
    <SpendLimitPerUserTerm>Quarterly</SpendLimitPerUserTerm>
    <GLCode>6032</GLCode>
    <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
    <PrepaidCode />
    <RequireReceiptOverride>0</RequireReceiptOverride>
    <RequireReceiptThresholdAmount>0</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>Accounting:6033</Name>
    <Description />
    <Data />
    <ExpenseTypeID>1</ExpenseTypeID>
    <MaxAmount>100</MaxAmount>
    <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
    <SpendLimitPerUser>0</SpendLimitPerUser>
    <SpendLimitPerUserCurrencyType />
    <SpendLimitPerUserTerm />
    <GLCode>6033</GLCode>
    <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
    <PrepaidCode />
    <RequireReceiptOverride>0</RequireReceiptOverride>
    <RequireReceiptThresholdAmount>0</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>
Fields
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’).
SpendLimitPerUser The maximum amount permitted per user for this category within the SpendLimitPerUserTerm specified.
SpendLimitPerUserCurrencyType The currency code for the spend limit per user (e.g. 'GBP', 'USD')
SpendLimitPerUserTerm The time frame to be used for this SpendLimitPerUser (Weekly, Monthly, Quarterly, Yearly)
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. (Max Length: 255) No string
Description body The internal description for the expense category. (Max Length: 2000) No string
Data body Used to store various internal code values for the expense category. (Max Length: 255) 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
SpendLimitPerUser body The maximum amount permitted per user for this category within the SpendLimitPerUserTerm specified. No string
SpendLimitPerUserCurrencyType body The currency code for the spend limit per user (i.e. ‘GBP’, ‘USD’). No string
SpendLimitPerUserTerm body The time frame to be used for this SpendLimitPerUser (Weekly, Monthly, Quarterly, Yearly) No string
GLCode body The general ledger code associated with this expense category. (Max Length: 255) 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). (Max Length: 255) 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",
      "SpendLimitPerUser": 1000,
      "SpendLimitPerUserCurrencyType": "USD",
      "SpendLimitPerUserTerm": "Quarterly",
      "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",
      "SpendLimitPerUser": 0,
      "SpendLimitPerUserCurrencyType": "",
      "SpendLimitPerUserTerm": "",
      "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</MaxAmount>
    <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
    <SpendLimitPerUser>1000</SpendLimitPerUser>
    <SpendLimitPerUserCurrencyType>USD</SpendLimitPerUserCurrencyType>
    <SpendLimitPerUserTerm>Quarterly</SpendLimitPerUserTerm>
    <GLCode>6032</GLCode>
    <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
    <PrepaidCode />
    <RequireReceiptOverride>0</RequireReceiptOverride>
    <RequireReceiptThresholdAmount>0</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>Accounting:6033</Name>
    <Description />
    <Data />
    <ExpenseTypeID>1</ExpenseTypeID>
    <MaxAmount>100</MaxAmount>
    <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
    <SpendLimitPerUser>0</SpendLimitPerUser>
    <SpendLimitPerUserCurrencyType />
    <SpendLimitPerUserTerm />
    <GLCode>6033</GLCode>
    <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
    <PrepaidCode />
    <RequireReceiptOverride>0</RequireReceiptOverride>
    <RequireReceiptThresholdAmount>0</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>
Fields
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. (Max Length: 255) No string
Description body The internal description for the expense category. (Max Length: 2000) No string
Data body Used to store various internal code values for the expense category. (Max Length: 255) 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
SpendLimitPerUser body The maximum amount permitted per user for this category within the SpendLimitPerUserTerm specified. No string
SpendLimitPerUserCurrencyType body The currency code for the spend limit per user (i.e. ‘GBP’, ‘USD’). No string
SpendLimitPerUserTerm body The time frame to be used for this SpendLimitPerUser (Weekly, Monthly, Quarterly, Yearly) No string
GLCode body The general ledger code associated with this expense category. (Max Length: 255) 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). (Max Length: 255) 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</MaxAmount>
  <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
  <GLCode>6032</GLCode>
  <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
  <PrepaidCode />
  <RequireReceiptOverride>0</RequireReceiptOverride>
  <RequireReceiptThresholdAmount>0</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>
Fields
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.
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
{
   "ExpenseCategories": [
    {
      "ID": "9f903b49-64dc-45c8-8216-2928ed2b6b2e",
      "Name": "Sales & Marketing:6032",
      "Description": "",
      "Data": "",
      "ExpenseTypeID": 1,
      "MaxAmount": 0,
      "MaxAmountCurrencyType": "USD",
      "SpendLimitPerUser": "1000",
      "SpendLimitPerUserCurrencyType": "USD",
      "SpendLimitPerUserTerm": "Quarterly",
      "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</MaxAmount>
    <MaxAmountCurrencyType>USD</MaxAmountCurrencyType>
    <SpendLimitPerUser>1000</SpendLimitPerUser>
    <SpendLimitPerUserCurrencyType>USD</SpendLimitPerUserCurrencyType>
    <SpendLimitPerUserTerm>Quarterly</SpendLimitPerUserTerm>
    <GLCode>6032</GLCode>
    <FilterDepartmentID>1a727dfe-4c9f-4108-ac0d-4fa5d512f83c</FilterDepartmentID>
    <PrepaidCode />
    <RequireReceiptOverride>0</RequireReceiptOverride>
    <RequireReceiptThresholdAmount>0</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>
Fields
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’).
SpendLimitPerUser body The maximum amount permitted per user for this category within the SpendLimitPerUserTerm specified. No string
SpendLimitPerUserCurrencyType body The currency code for the spend limit per user (i.e. ‘GBP’, ‘USD’). No string
SpendLimitPerUserTerm body The time frame to be used for this SpendLimitPerUser (Weekly, Monthly, Quarterly, Yearly) No string
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 expense reports. Reports can also be viewed in the browser by logged in users. Use the following URL with an updated expense report GUID: https://expense.certify.com/ViewExpRpt.aspx?__GUID={Report ID} Appending '&pdf=1' to the end of the URL will return a PDF of the expense report. Example: https://expense.certify.com/ViewExpRpt.aspx?__GUID={Report ID}&pdf=1

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. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss optional.
enddate query Ending point for the processed date range. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss optional.
dateformat query The returned date/datetime format of all date values in the response. No string("date" for "yyyy-MM-dd" - default, "datetime" for "yyyy-MM-dd HH:mm:ss")
datetype query The type of date, accountant assigned or true action date of when the expense report was processed. No string(0 for accountant assigned processed date - default, 1 for true processed date)
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
processed query Expense report has been processed No string (1 for yes - default, 0 for no, 2 for both)
reimbursed query Expense report has been reimbursed No string (1 for yes, 0 for no, 2 for both - default)
reimbursedstartdate query Starting point for the report reimbursement process. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss optional
reimbursedenddate query Ending point for the report reimbursement process. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss optional
clearcache query For improved efficiency, this endpoint caches results for 15 minutes. Include this parameter to refresh the cache and obtain updated values instantly. No string (1 to clear cache)
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,
      "ReimAmount": 292.04,
      "TotalAmount": 292.04,
      "Currency": "USD",
      "SubmittedDate": "2017-02-03",
      "InitialApprovalDate": "",
      "Processed": false,
      "ProcessedDate": "",
      "ApprovalCode": "",
      "InitialApproverEmail": "rrobot@certify.com",
      "StartDate": "2017-01-01",
      "EndDate": "2017-01-31",
      "ExpenseReportName": "Business Trip January 2017",
      "ExpenseReportDescription": "Project Jan",
      "Status": "Drafts",
      "LastAction": "None",
      "APSyncComplete": false,
      "Reimbursed": false,
      "ReimbursedDate": "",
      "ReimbursementTransactionID": "Manual Pay",
      "EmpGLD1Name": "test",
      "EmpGLD1Code": "test",
      "EmpGLD2Name": "A",
      "EmpGLD2Code": "A",
      "EmpGLD3Name": "",
      "EmpGLD3Code": "",
      "EmpGLD4Name": "",
      "EmpGLD4Code": "",
      "EmpGLD5Name": "",
      "EmpGLD5Code": "",
      "TrueProcessedDate": "",
      "CurrentApprover": {
                "ApproverID": "",
                "ApproverFirstName": "",
                "ApproverLastName": "",
                "ApproverEmail": "",
                "ApproverRole": ""
      },
      "SettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    },
    {
      "ID": "a9109697-ew08-45f1-9338-994e046a07ed",
      "EmployeeDepartment": "General",
      "FirstName": "Robbie",
      "LastName": "The Robot",
      "EmployeeID": "rrobot002",
      "NonReimAmount": 34.4,
      "ReimAmount": 0,
      "TotalAmount": 34.4,
      "Currency": "USD",
      "SubmittedDate": "2017-02-03",
      "InitialApprovalDate": "",
      "Processed": false,
      "ProcessedDate": "",
      "ApprovalCode": 23,
      "InitialApproverEmail": "rrobot@certify.com",
      "StartDate": "2017-01-23",
      "EndDate": "2017-01-30",
      "ExpenseReportName": "Visit to Alpaca Farm, Inc.",
      "ExpenseReportDescription": "",
      "Status": "Pending",
      "LastAction": "None",
      "APSyncComplete": false,
      "Reimbursed": false,
      "ReimbursedDate": "",
      "ReimbursementTransactionID": "04252018165201",
      "EmpGLD1Name": "test",
      "EmpGLD1Code": "test",
      "EmpGLD2Name": "A",
      "EmpGLD2Code": "A",
      "EmpGLD3Name": "",
      "EmpGLD3Code": "",
      "EmpGLD4Name": "",
      "EmpGLD4Code": "",
      "EmpGLD5Name": "",
      "EmpGLD5Code": "",
      "TrueProcessedDate": "",
      "CurrentApprover": {
                "ApproverID": "dd84dc57-f2e7-4920-954e-b62bdab8459f",
                "ApproverFirstName": "Steve",
                "ApproverLastName": "Manager",
                "ApproverEmail": "SteveManager@Company.com",
                "ApproverRole": "Manager"
      },
      "SettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    }
  ]
<ExpenseReports>
  <ExpenseReport>
    <ID>fdf32884-af87-4991-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 />
    <Processed>false</Processed>
    <ProcessedDate />
    <ApprovalCode />
    <InitialApproverEmail>rrobot@certify.com</InitialApproverEmail>
    <StartDate>2017-01-01</StartDate>
    <EndDate>2017-01-31</EndDate>
    <ExpenseReportName>Business Trip January 2017</ExpenseReportName>
    <ExpenseReportDescription>Project Jan</ExpenseReportDescription>
    <Status>Drafts</Status>
    <LastAction>None</LastAction>
    <APSyncComplete>false</APSyncComplete>
    <Reimbursed>false</Reimbursed>
    <ReimbursedDate />
    <ReimbursementTransactionID>Manual Pay</ReimbursementTransactionID>
    <EmpGLD1Name>test</EmpGLD1Name>
    <EmpGLD1Code>test</EmpGLD1Code>
    <EmpGLD2Name>A</EmpGLD2Name>
    <EmpGLD2Code>A</EmpGLD2Code>
    <EmpGLD3Name />
    <EmpGLD3Code />
    <EmpGLD4Name />
    <EmpGLD4Code />
    <EmpGLD5Name />
    <EmpGLD5Code />
    <TrueProcessedDate />
    <CurrentApprover>
            <ApproverID />
            <ApproverFirstName />
            <ApproverLastName />
            <ApproverEmail />
            <ApproverRole />
    </CurrentApprover>
    <SettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</SettlementAccountID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </ExpenseReport>
  <ExpenseReport>
    <ID>a9109697-ew08-45f1-9338-994e046a07ed</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <EmployeeID>rrobot002</EmployeeID>
    <NonReimAmount>34.4</NonReimAmount>
    <ReimAmount>0</ReimAmount>
    <TotalAmount>34.4</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2017-02-03</SubmittedDate>
    <InitialApprovalDate />
    <Processed>false</Processed>
    <ProcessedDate />
    <ApprovalCode>23</ApprovalCode>
    <InitialApproverEmail>rrobot@certify.com</InitialApproverEmail>
    <StartDate>2017-01-23</StartDate>
    <EndDate>2017-01-30</EndDate>
    <ExpenseReportName>Visit to Alpaca Farm, Inc.</ExpenseReportName>
    <ExpenseReportDescription />
    <Status>Pending</Status>
    <LastAction>None</LastAction>
    <APSyncComplete>false</APSyncComplete>
    <Reimbursed>false</Reimbursed>
    <ReimbursedDate />
    <ReimbursementTransactionID>04252018165201</ReimbursementTransactionID>
    <EmpGLD1Name>test</EmpGLD1Name>
    <EmpGLD1Code>test</EmpGLD1Code>
    <EmpGLD2Name>A</EmpGLD2Name>
    <EmpGLD2Code>A</EmpGLD2Code>
    <EmpGLD3Name />
    <EmpGLD3Code />
    <EmpGLD4Name />
    <EmpGLD4Code />
    <EmpGLD5Name />
    <EmpGLD5Code />
    <TrueProcessedDate />
    <CurrentApprover>
            <ApproverID>fe4adc49-2de9-42a3-9ba7-0fa1729f21a4</ApproverID>
            <ApproverFirstName>Steve</ApproverFirstName>
            <ApproverLastName>Manager</ApproverLastName>
            <ApproverEmail>SteveManager@Company.com</ApproverEmail>
            <ApproverRole>Manager</ApproverRole>
    </CurrentApprover>
    <SettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</SettlementAccountID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </ExpenseReport>
</ExpenseReports>
Fields
Field Value Description
ID Unique ID of the Expense Report.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeEmail
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[ HH:mm:ss]).
InitialApprovalDate Date the first user approved the expense report.
Processed Indicates whether the expense report has been processed. (true/false)
ProcessedDate Date on which the expense report was processed. (yyyy-MM-dd[ HH:mm:ss])
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[ HH:mm:ss])
EndDate End date of the expense report. (yyyy-MM-dd[ HH:mm:ss])
ExpenseReportName Name of the expense report.
ExpenseReportDescription Description of the expense report.
Status Status of the expense report (Drafts, Pending, Completed).
LastAction Last action performed on the expense report (None, Approved, Disapproved).
APSyncComplete Indicates whether the expense report has been synchronized with a third party AP system. (true/false)
Reimbursed Indicates whether the expense report has been reimbursed. (true/false)
ReimbursedDate Indicates date the expense report was reimbursed. (yyyy-MM-dd[ HH:mm:ss])
ReimbursementTransactionID The numeric ACH transaction ID or 'Manual Pay'.
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 name or code of the value of the Employee General Ledger Dimension 2-5 (see above).
EmpGLD2Code
EmpGLD3Name
EmpGLD3Code
EmpGLD4Name
EmpGLD4Code
EmpGLD5Name
EmpGLD5Code
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
CurrentApprover Populates if the report is currently pending approval. (Object)
 ApproverID Unique user ID for the approver.
 ApproverFirstName First name of the approver.
 ApproverLastName Last name of the approver.
 ApproverEmail Email address of the approver.
 ApproverRole Assigned role of the approver.
SettlementAccountID Unique ID of the receipt.
SettlementAccountName Name of the settlement account.
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,
      "ReimAmount": 292.04,
      "TotalAmount": 292.04,
      "Currency": "USD",
      "SubmittedDate": "2017-02-03",
      "InitialApprovalDate": "",
      "Processed": false,
      "ProcessedDate": "",
      "ApprovalCode": "",
      "InitialApproverEmail": "rrobot@certify.com",
      "StartDate": "2017-01-01",
      "EndDate": "2017-01-31",
      "ExpenseReportName": "Business Trip January 2017",
      "ExpenseReportDescription": "Project Jan",
      "Status": "Drafts",
      "LastAction": "None",
      "APSyncComplete": false,
      "Reimbursed": false,
      "ReimbursedDate": "",
      "ReimbursementTransactionID": "Manual Pay",
      "EmpGLD1Name": "test",
      "EmpGLD1Code": "test",
      "EmpGLD2Name": "A",
      "EmpGLD2Code": "A",
      "EmpGLD3Name": "",
      "EmpGLD3Code": "",
      "EmpGLD4Name": "",
      "EmpGLD4Code": "",
      "EmpGLD5Name": "",
      "EmpGLD5Code": "",
      "TrueProcessedDate": "",
      "CurrentApprover": {
                "ApproverID": "",
                "ApproverFirstName": "",
                "ApproverLastName": "",
                "ApproverEmail": "",
                "ApproverRole": ""
      },
      "SettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    }
<ExpenseReports>
  <ExpenseReport>
    <ID>fdf32884-af87-4991-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 />
    <Processed>false</Processed>
    <ProcessedDate />
    <ApprovalCode />
    <InitialApproverEmail>rrobot@certify.com</InitialApproverEmail>
    <StartDate>2017-01-01</StartDate>
    <EndDate>2017-01-31</EndDate>
    <ExpenseReportName>Business Trip January 2017</ExpenseReportName>
    <ExpenseReportDescription>Project Jan</ExpenseReportDescription>
    <Status>Drafts</Status>
    <LastAction>None</LastAction>
    <APSyncComplete>false</APSyncComplete>
    <Reimbursed>false</Reimbursed>
    <ReimbursedDate />
    <ReimbursementTransactionID>Manual Pay</ReimbursementTransactionID>
    <EmpGLD1Name>test</EmpGLD1Name>
    <EmpGLD1Code>test</EmpGLD1Code>
    <EmpGLD2Name>A</EmpGLD2Name>
    <EmpGLD2Code>A</EmpGLD2Code>
    <EmpGLD3Name />
    <EmpGLD3Code />
    <EmpGLD4Name />
    <EmpGLD4Code />
    <EmpGLD5Name />
    <EmpGLD5Code />
    <TrueProcessedDate />
    <CurrentApprover>
            <ApproverID />
            <ApproverFirstName />
            <ApproverLastName />
            <ApproverEmail />
            <ApproverRole />
    </CurrentApprover>
    <SettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</SettlementAccountID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </ExpenseReport>
</ExpenseReports>
Fields
Field Value Description
ID Unique ID of the Expense Report.
EmployeeDepartment Property fields of the employee who the invoice report belongs to.
FirstName
LastName
EmployeeEmail
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[ HH:mm:ss]).
InitialApprovalDate Date the first user approved the expense report.
Processed Indicates whether the expense report has been processed. (true/false)
ProcessedDate Date on which the expense report was processed. (yyyy-MM-dd[ HH:mm:ss])
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[ HH:mm:ss])
EndDate End date of the expense report. (yyyy-MM-dd[ HH:mm:ss])
ExpenseReportName Name of the expense report.
ExpenseReportDescription Description of the expense report.
Status Status of the expense report (Drafts, Pending, Completed).
LastAction Last action performed on the expense report (None, Approved, Disapproved).
APSyncComplete Indicates whether the expense report has been synchronized with a third party AP system. (true/false)
Reimbursed Indicates whether the expense report has been reimbursed. (true/false)
ReimbursedDate Indicates date the expense report was reimbursed. (yyyy-MM-dd[ HH:mm:ss])
ReimbursementTransactionID The numeric ACH transaction ID or 'Manual Pay'.
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 name or code of the value of the Employee General Ledger Dimension 2-5 (see above).
EmpGLD2Code
EmpGLD3Name
EmpGLD3Code
EmpGLD4Name
EmpGLD4Code
EmpGLD5Name
EmpGLD5Code
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
CurrentApprover Populates if the report is currently pending approval. (Object)
 ApproverID Unique user ID for the approver.
 ApproverFirstName First name of the approver.
 ApproverLastName Last name of the approver.
 ApproverEmail Email address of the approver.
 ApproverRole Assigned role of the approver.
SettlementAccountID Unique ID of the receipt.
SettlementAccountName Name of the settlement account.
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. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
enddate query Ending point for the processed date range. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
dateformat query The returned date/datetime format of all date values in the response. No string("date" for "yyyy-MM-dd" - default, "datetime" for "yyyy-MM-dd HH:mm:ss")
datetype query The type of date, accountant assigned or true action date of when the expense report was processed. No string(0 for accountant assigned processed date - default, 1 for true processed date when accountant processed the report )
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
{
   "Expenses": [
    {
      "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.93,
      "Billable": false,
      "Reimbursable": true,
      "ReimAmount": 191.96,
      "SubmittedAmount": 0,
      "ConvertedAmount": 0,
      "ConvertedReimAmount": 0,
      "ExchangeRate": 1,
      "ExpenseDate": "2016-05-03",
      "PostingDate": "",
      "LodgingCheckInDate": "2016-05-01",
      "LodgingCheckOutDate": "2016-05-03",
      "RentalPickUpDate": "",
      "RentalDropOffDate": "",
      "Vendor": "Mountain View Hotel",
      "Location": "Mountain View, CA",
      "TravelFrom": "",
      "TravelTo": "",
      "MileageFrom": "",
      "MileageTo": "",
      "MileageUnits": "0.0",
      "ExpenseReportName": "Business Trip May 2016",
      "ExpenseReportApprovalCode": 52,
      "Status": "Completed",
      "LastAction": "Approved",
      "ProcessedDate": "2016-05-30",
      "Processed": true,
      "Currency": "USD",
      "SubmittedCurrency": "",
      "ConvertedCurrency": "",
      "Reason": "Hotel Stay",
      "VATAmount": 0,
      "HSTAmount": 0,
      "PSTAmount": 0,
      "ExpenseTextGLD1Label": "Text GLD Expense",
      "ExpenseTextGLD1": "business",
      "ExpenseTextGLD2Label": "Numbers Only GLD",
      "ExpenseTextGLD2": "123",
      "ExpenseReportGLD1Label": "Food",
      "ExpenseReportGLD1Name": "Apples and Oranges",
      "ExpenseReportGLD1Code": "A123",
      "ReceiptImageLink": "{unique receipt image url}",
      "ReceiptID": "",
      "PaymentCardName": "Company Visa",
      "CCLast": "0005",
      "CCTransactionID": "000008806037561_20160503_192.93",
      "ExpenseCategoryID": "a326e9a2-a2ab-4eda-b924-234d8fe146c2",
      "TrueProcessedDate": "2016-06-01",
      "Inquiries": [
          {
                "RequestorID": "c3b8ab6f-7378-4991-96c5-876d7a8d208c"
                "RequestorFirstName": "Steve"
                "RequestorLastName": "Manager"
                "RequestorEmail": "SteveManager@Company.com"
                "RequestDate": "2023-05-08"
                "Inquiry": "Please update to the correct expense category"
                "Response": "Done!"
                "ResponseDate": "2023-05-09"
          }
      ],
      "Notes": [
          {
                "SubmitterID": "02102f72-0ac2-4472-b98a-77800f780f99"
                "SubmitterFirstName": "Steve"
                "SubmitterLastName": "Manager"
                "SubmitterEmail": "SteveManager@Company.com"
                "Date": "2023-06-07"
                "Note": "Corrected expense category"
                "Flagged": "False"
          }
      ],
      "MealAttendees": "",
      "DetailedMealAttendees": []
    },
    {
      "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": "Meals",
      "ExpenseCategory": "New Hire Lunch",
      "ExpenseCategoryGLCode": "01",
      "Amount": 150,
      "Billable": false,
      "Reimbursable": false,
      "ReimAmount": 0,
      "SubmittedAmount": 0,
      "ConvertedAmount": 0,
      "ConvertedReimAmount": 0,
      "ExchangeRate": 1,
      "ExpenseDate": "2016-06-22",
      "PostingDate": "",
      "LodgingCheckInDate": "",
      "LodgingCheckOutDate": "",
      "RentalPickUpDate": "",
      "RentalDropOffDate": "",
      "Vendor": "Bingas",
      "Location": "Mountain View, CA",
      "TravelFrom": "",
      "TravelTo": "",
      "MileageFrom": "",
      "MileageTo": "",
      "MileageUnits": 0,
      "ProcessedDate": "2016-06-22",
      "Processed": true,
      "Currency": "USD",
      "SubmittedCurrency": "",
      "ConvertedCurrency": "",
      "Reason": "Airfare",
      "VATAmount": 0,
      "HSTAmount": 0,
      "PSTAmount": 0,
      "ExpenseTextGLD1Label": "Text GLD Expense",
      "ExpenseTextGLD1": "Marketing Convention",
      "ExpenseTextGLD2Label": "Numbers Only GLD",
      "ExpenseReportGLD1Label": "Food",
      "ExpenseReportGLD1Name": "Surf and Turf",
      "ExpenseReportGLD1Code": "st001",
      "ReceiptImageLink": "{unique receipt image url}",
      "ReceiptID": "",
      "PaymentCardName": "Company Mastercard",
      "CCLast": "0005",
      "CCTransactionID": "000008806037561_20160622_150.00",
      "ExpenseCategoryID": "a336e9a2-a2ab-4eda-b924-234d8fe146c2",
      "TrueProcessedDate": "2016-06-22",
      "Inquiries": [],
      "Notes": [],
      "MealAttendees": "",
      "DetailedMealAttendees": [
          {
                "FirstName": "Robbie"
                "LastName": "The Robot"
                "Title": ""
                "Company": ""
                "Relation": "Self"
          }
          {
                "FirstName": "Steve"
                "LastName": "Manager"
                "Title": "Manager"
                "Company": "TheCompany"
                "Relation": "Employee"
          }
          {
                "FirstName": "John"
                "LastName": "NewHire"
                "Title": "Employee"
                "Company": "TheCompany"
                "Relation": "Employee"
          }
      ]
    }
  ]
}
<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.93</Amount>
    <Billable>false</Billable>
    <Reimbursable>true</Reimbursable>
    <ReimAmount>191.96</ReimAmount>
    <SubmittedAmount>0</SubmittedAmount>
    <ConvertedAmount>0</ConvertedAmount>
    <ConvertedReimAmount>0</ConvertedReimAmount>
    <ExchangeRate>1</ExchangeRate>
    <ExpenseDate>2016-05-03</ExpenseDate>
    <PostingDate />
    <LodgingCheckInDate>2016-05-01</LodgingCheckInDate>
    <LodgingCheckOutDate>2016-05-03</LodgingCheckOutDate>
    <RentalPickUpDate />
    <RentalDropOffDate />
    <Vendor>Mountain View Hotel</Vendor>
    <Location>Mountain View, CA</Location>
    <TravelFrom />
    <TravelTo />
    <MileageFrom />
    <MileageTo />
    <MileageUnits>0.0</MileageUnits>
    <ExpenseReportName>Business Trip May 2016</ExpenseReportName>
    <ExpenseReportApprovalCode>52</ExpenseReportApprovalCode>
    <Status>Completed</Status>
    <LastAction>Approved</LastAction>
    <ProcessedDate>2016-05-30</ProcessedDate>
    <Processed>true</Processed>
    <Currency>USD</Currency>
    <SubmittedCurrency />
    <ConvertedCurrency />
    <Reason>Hotel Stay</Reason>
    <VATAmount>0</VATAmount>
    <HSTAmount>0</HSTAmount>
    <PSTAmount>0</PSTAmount>
    <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
    <ExpenseTextGLD1>business</ExpenseTextGLD1>
    <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
    <ExpenseTextGLD2>123</ExpenseTextGLD2>
    <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
    <ExpenseReportGLD1Name>Apples and Oranges</ExpenseReportGLD1Name>
    <ExpenseReportGLD1Code>A123</ExpenseReportGLD1Code>
    <ReceiptImageLink>{unique receipt image url}</ReceiptImageLink>
    <ReceiptID />
    <PaymentCardName>Company Visa</PaymentCardName>
    <CCLast>0005</CCLast>
    <CCTransactionID>000008806037561_20160503_192.93</CCTransactionID>
    <ExpenseCategoryID>a326e9a2-a2ab-4eda-b924-234d8fe146c2</ExpenseCategoryID>
    <TrueProcessedDate>2016-06-01</TrueProcessedDate>
    <Inquiries>
        <Inquiry>
            <RequestorID>48ac616e-410c-4abb-8fab-308a4db111f3</RequestorID>
            <RequestorFirstName>Steve</RequestorFirstName>
            <RequestorLastName>Manager</RequestorLastName>
            <RequestorEmail>SteveManager@Company.com</RequestorEmail>
            <RequestDate>2023-05-08</RequestDate>
            <Inquiry>Please update to the correct expense category</Inquiry>
            <Response>Done!</Response>
            <ResponseDate>2023-05-09</ResponseDate>
        </Inquiry>
    </Inquiries>
    <Notes>
        <Note>
            <SubmitterID>428871b6-b0d7-4f32-ac68-5ff86601eadb</SubmitterID>
            <SubmitterFirstName>Steve</SubmitterFirstName>
            <SubmitterLastName>Manager</SubmitterLastName>
            <SubmitterEmail>SteveManager@Company.com</SubmitterEmail>
            <Date>2023-06-07</Date>
            <Note>Corrected expense category</Note>
            <Flagged>False</Flagged>
        </Note>
    </Notes>
    <MealAttendees />
    <DetailedMealAttendees />
  </Expense>
  <Expense>
    <ID>e373a213-1dd3-4e3d-83b7-786bd9a5e201</ID>
    <ExpenseReportID>9b7146b0-3e92-4745-babf-8bda8973238a</ExpenseReportID>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <Email>rrobot@certify.com</Email>
    <EmployeeID>rrobot002</EmployeeID>
    <DepartmentName>Marketing</DepartmentName>
    <DepartmentCode>02</DepartmentCode>
    <ExpenseType>Meals</ExpenseType>
    <ExpenseCategory>New Hire Lunch</ExpenseCategory>
    <ExpenseCategoryGLCode>01</ExpenseCategoryGLCode>
    <Amount>150</Amount>
    <Billable>false</Billable>
    <Reimbursable>false</Reimbursable>
    <ReimAmount>0</ReimAmount>
    <SubmittedAmount>0</SubmittedAmount>
    <ConvertedAmount>0</ConvertedAmount>
    <ConvertedReimAmount>0</ConvertedReimAmount>
    <ExchangeRate>1</ExchangeRate>
    <ExpenseDate>2016-06-22</ExpenseDate>
    <PostingDate />
    <LodgingCheckInDate />
    <LodgingCheckOutDate />
    <RentalPickUpDate />
    <RentalDropOffDate />
    <Vendor>Bingas</Vendor>
    <Location>Mountain View, CA</Location>
    <TravelFrom />
    <TravelTo />
    <MileageFrom />
    <MileageTo />
    <MileageUnits>0</MileageUnits>
    <ProcessedDate>2016-06-22</ProcessedDate>
    <Processed>true</Processed>
    <Currency>USD</Currency>
    <SubmittedCurrency />
    <ConvertedCurrency />
    <Reason>Airfare</Reason>
    <VATAmount>0</VATAmount>
    <HSTAmount>0</HSTAmount>
    <PSTAmount>0</PSTAmount>
    <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
    <ExpenseTextGLD1>Marketing Convention</ExpenseTextGLD1>
    <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
    <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
    <ExpenseReportGLD1Name>Surf and Turf</ExpenseReportGLD1Name>
    <ExpenseReportGLD1Code>st001</ExpenseReportGLD1Code>
    <ReceiptImageLink>{unique receipt image url}</ReceiptImageLink>
    <ReceiptID />
    <PaymentCardName>Company Mastercard</PaymentCardName>
    <CCLast>0005</CCLast>
    <CCTransactionID>000008806037561_20160622_150.00</CCTransactionID>
    <ExpenseCategoryID>a336e9a2-a2ab-4eda-b924-234d8fe146c2</ExpenseCategoryID>
    <TrueProcessedDate>2016-06-22</TrueProcessedDate>
    <Inquiries />
    <Notes />
    <MealAttendees />
    <DetailedMealAttendees>
        <MealAttendee>
            <FirstName>Robbie</FirstName>
            <LastName>The Robot</LastName>
            <Title />
            <Company />
            <Relation>Self</Relation>
        </MealAttendee>
        <MealAttendee>
            <FirstName>Steve</FirstName>
            <LastName>Manager</LastName>
            <Title>Manager</Title>
            <Company>TheCompany</Company>
            <Relation>Employee</Relation>
        </MealAttendee>
        <MealAttendee>
            <FirstName>John</FirstName>
            <LastName>NewHire</LastName>
            <Title>Employee</Title>
            <Company>TheCompany</Company>
            <Relation>Employee</Relation>
        </MealAttendee>
    </DetailedMealAttendees>
  </Expense>
</Expenses>
Fields
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.
Status Status of the expense (Wallet, Drafts, Pending, Completed)
LastAction Last action performed on the expense (None, Approved, Disapproved)
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.
ConvertedAmount Total amount of the expense in the submitting users default currency.
ConvertedReimAmount Reimbursable amount of the expense in the submitting users default currency.
ExchangeRate The exchange rate used to convert the expense to the submitter's default currency.
ExpenseDate The date/datetime of the expense (yyyy-MM-dd[ HH:mm:ss]).
PostingDate The posting date of the expense as supplied by credit card feed (yyyy-MM-dd[ HH:mm:ss]).
LodgingCheckInDate The lodging check in date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
LodgingCheckOutDate The lodging check out date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
RentalPickUpDate The rental pick up date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
RentalDropOffDate The rental drop off date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
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[ HH:mm:ss]).
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"
ConvertedCurrency Three letter code of the currency of the converted expense. 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.
MileageFrom The origin location for mileage-based expense categories.
MileageTo The destination location for mileage-based expense categories.
MileageDistance The total distance traveled for mileage-based expense categories. Unit type dependent on Mileage Rate (Miles, Kilometers)
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.
CCTransactionID The credit card transaction ID supplied by the financial institution.
ExpenseCategoryID A numeric unique identifier for the expense category of each returned expense.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
Inquiries An inquiry allows an approver to request specific information from the submitter, or to allow editing the submitted expense. (Object array)
 RequestorID Unique user ID for the inquiry requestor.
 RequestorFirstName First name of the inquiry requestor.
 RequestorLastName Last name of the inquiry requestor.
 RequestorEmail Email address of the inquiry requestor.
 RequestDate Date the requestor submitted the inquiry.
 Inquiry Requestor's inquiry message.
 Response Expense submitter's response.
 ResponseDate Date of expense submitter's response.
Notes An approver may add notes to an individual expense line. (Object array)
 SubmitterID Unique user ID for the note submitter.
 SubmitterFirstName First name of the note submitter.
 SubmitterLastName Last name of the note submitter.
 SubmitterEmail Submitter's email address.
 Date Creation date of the note.
 Note Content of the note added.
 Flagged True/False, if submitter flagged the expense item for review.
MealAttendees Attendee information for non-detailed attendee meal categories.
DetailedMealAttendees Detailed information about each attendee associated to the meal expense. (Object array)
 FirstName Attendee's first name.
 LastName Attendee's last name.
 Title Attendee's title.
 Company Attendee's company.
 Relation Relationship with expense submitter. Can be one of Self,Employee,Client/Customer,Prospect, Vendor, Other.
GET
/expenses
Expand Method
Description

This method returns a list of one or more expenses.

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. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
enddate query Ending point for the processed date range. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
dateformat query The returned date/datetime format of all date values in the response. No string("date" for "yyyy-MM-dd" - default, "datetime" for "yyyy-MM-dd HH:mm:ss")
datetype query The type of date, accountant assigned or true action date of when the expense report was processed. No string(0 for accountant assigned processed date - default, 1 for true processed date when accountant processed the report, 2 for credit card file processed date )
batchid query A unique ID provided by Certify, specifying a batched group of expenses for export. No string
processed query Expense report has been processed No string (1 for yes - default, 0 for no, 2 for both)
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
includedisapproved query Include disapproved expenses No string (0 for no - default, 1 for yes)
clearcache query For improved efficiency, this endpoint caches results for 15 minutes. Include this parameter to refresh the cache and obtain updated values instantly. No string (1 to clear cache)
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
{
   "Expenses": [
    {
      "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.93,
      "Billable": false,
      "Reimbursable": true,
      "ReimAmount": 191.96,
      "SubmittedAmount": 0,
      "ConvertedAmount": 0,
      "ConvertedReimAmount": 0,
      "ExchangeRate": 1,
      "ExpenseDate": "2016-05-03",
      "PostingDate": "",
      "LodgingCheckInDate": "2016-05-01",
      "LodgingCheckOutDate": "2016-05-03",
      "RentalPickUpDate": "",
      "RentalDropOffDate": "",
      "Vendor": "Mountain View Hotel",
      "Location": "Mountain View, CA",
      "TravelFrom": "",
      "TravelTo": "",
      "MileageFrom": "",
      "MileageTo": "",
      "MileageUnits": "0.0",
      "ExpenseReportName": "Business Trip May 2016",
      "ExpenseReportApprovalCode": 52,
      "Status": "Completed",
      "LastAction": "Approved",
      "ProcessedDate": "2016-05-30",
      "Processed": true,
      "Currency": "USD",
      "SubmittedCurrency": "",
      "ConvertedCurrency": "",
      "Reason": "Hotel Stay",
      "VATAmount": 0,
      "HSTAmount": 0,
      "PSTAmount": 0,
      "ExpenseTextGLD1Label": "Text GLD Expense",
      "ExpenseTextGLD1": "business",
      "ExpenseTextGLD2Label": "Numbers Only GLD",
      "ExpenseTextGLD2": "123",
      "ExpenseReportGLD1Label": "Food",
      "ExpenseReportGLD1Name": "Apples and Oranges",
      "ExpenseReportGLD1Code": "A123",
      "ReceiptImageLink": "{unique receipt image url}",
      "ReceiptID": "",
      "PaymentCardName": "Company Visa",
      "CCLast": "0005",
      "CCTransactionID": "000008806037561_20160503_192.93",
      "ExpenseCategoryID": "a326e9a2-a2ab-4eda-b924-234d8fe146c2",
      "TrueProcessedDate": "2016-06-01",
      "Inquiries": [
          {
                "RequestorID": "090a29cb-c6e6-4311-b8f5-75905048744d"
                "RequestorFirstName": "Steve"
                "RequestorLastName": "Manager"
                "RequestorEmail": "SteveManager@Company.com"
                "RequestDate": "2023-05-08"
                "Inquiry": "Please update to the correct expense category"
                "Response": "Done!"
                "ResponseDate": "2023-05-09"
          }
      ],
      "Notes": [
          {
                "SubmitterID": "1f87b2b0-6f6e-4c24-b2a0-09573e2f9feb"
                "SubmitterFirstName": "Steve"
                "SubmitterLastName": "Manager"
                "SubmitterEmail": "SteveManager@Company.com"
                "Date": "2023-06-07"
                "Note": "Corrected expense category"
                "Flagged": "False"
          }
      ],
      "MealAttendees": "",
      "DetailedMealAttendees": []
    },
    {
      "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": "Meals",
      "ExpenseCategory": "New Hire Lunch",
      "ExpenseCategoryGLCode": "01",
      "Amount": 150,
      "Billable": false,
      "Reimbursable": false,
      "ReimAmount": 0,
      "SubmittedAmount": 0,
      "ConvertedAmount": 0,
      "ConvertedReimAmount": 0,
      "ExchangeRate": 1,
      "ExpenseDate": "2016-06-22",
      "PostingDate": "",
      "LodgingCheckInDate": "",
      "LodgingCheckOutDate": "",
      "RentalPickUpDate": "",
      "RentalDropOffDate": "",
      "Vendor": "Bingas",
      "Location": "Mountain View, CA",
      "TravelFrom": "",
      "TravelTo": "",
      "MileageFrom": "",
      "MileageTo": "",
      "MileageUnits": 0,
      "ProcessedDate": "2016-06-22",
      "Processed": true,
      "Currency": "USD",
      "SubmittedCurrency": "",
      "ConvertedCurrency": "",
      "Reason": "Airfare",
      "VATAmount": 0,
      "HSTAmount": 0,
      "PSTAmount": 0,
      "ExpenseTextGLD1Label": "Text GLD Expense",
      "ExpenseTextGLD1": "Marketing Convention",
      "ExpenseTextGLD2Label": "Numbers Only GLD",
      "ExpenseReportGLD1Label": "Food",
      "ExpenseReportGLD1Name": "Surf and Turf",
      "ExpenseReportGLD1Code": "st001",
      "ReceiptImageLink": "{unique receipt image url}",
      "ReceiptID": "",
      "PaymentCardName": "Company Mastercard",
      "CCLast": "0005",
      "CCTransactionID": "000008806037561_20160622_150.00",
      "ExpenseCategoryID": "a336e9a2-a2ab-4eda-b924-234d8fe146c2",
      "TrueProcessedDate": "2016-06-22",
      "Inquiries": [],
      "Notes": [],
      "MealAttendees": "",
      "DetailedMealAttendees": [
          {
                "FirstName": "Robbie"
                "LastName": "The Robot"
                "Title": ""
                "Company": ""
                "Relation": "Self"
          }
          {
                "FirstName": "Steve"
                "LastName": "Manager"
                "Title": "Manager"
                "Company": "TheCompany"
                "Relation": "Employee"
          }
          {
                "FirstName": "John"
                "LastName": "NewHire"
                "Title": "Employee"
                "Company": "TheCompany"
                "Relation": "Employee"
          }
      ]
    }
  ]
}
<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.93</Amount>
    <Billable>false</Billable>
    <Reimbursable>true</Reimbursable>
    <ReimAmount>191.96</ReimAmount>
    <SubmittedAmount>0</SubmittedAmount>
    <ConvertedAmount>0</ConvertedAmount>
    <ConvertedReimAmount>0</ConvertedReimAmount>
    <ExchangeRate>1</ExchangeRate>
    <ExpenseDate>2016-05-03</ExpenseDate>
    <PostingDate />
    <LodgingCheckInDate>2016-05-01</LodgingCheckInDate>
    <LodgingCheckOutDate>2016-05-03</LodgingCheckOutDate>
    <RentalPickUpDate />
    <RentalDropOffDate />
    <Vendor>Mountain View Hotel</Vendor>
    <Location>Mountain View, CA</Location>
    <TravelFrom />
    <TravelTo />
    <MileageFrom />
    <MileageTo />
    <MileageUnits>0.0</MileageUnits>
    <ExpenseReportName>Business Trip May 2016</ExpenseReportName>
    <ExpenseReportApprovalCode>52</ExpenseReportApprovalCode>
    <Status>Completed</Status>
    <LastAction>Approved</LastAction>
    <ProcessedDate>2016-05-30</ProcessedDate>
    <Processed>true</Processed>
    <Currency>USD</Currency>
    <SubmittedCurrency />
    <ConvertedCurrency />
    <Reason>Hotel Stay</Reason>
    <VATAmount>0</VATAmount>
    <HSTAmount>0</HSTAmount>
    <PSTAmount>0</PSTAmount>
    <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
    <ExpenseTextGLD1>business</ExpenseTextGLD1>
    <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
    <ExpenseTextGLD2>123</ExpenseTextGLD2>
    <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
    <ExpenseReportGLD1Name>Apples and Oranges</ExpenseReportGLD1Name>
    <ExpenseReportGLD1Code>A123</ExpenseReportGLD1Code>
    <ReceiptImageLink>{unique receipt image url}</ReceiptImageLink>
    <ReceiptID />
    <PaymentCardName>Company Visa</PaymentCardName>
    <CCLast>0005</CCLast>
    <CCTransactionID>000008806037561_20160503_192.93</CCTransactionID>
    <ExpenseCategoryID>a326e9a2-a2ab-4eda-b924-234d8fe146c2</ExpenseCategoryID>
    <TrueProcessedDate>2016-06-01</TrueProcessedDate>
    <Inquiries>
        <Inquiry>
            <RequestorID>22249ebb-785f-4648-8465-890893ce0113</RequestorID>
            <RequestorFirstName>Steve</RequestorFirstName>
            <RequestorLastName>Manager</RequestorLastName>
            <RequestorEmail>SteveManager@Company.com</RequestorEmail>
            <RequestDate>2023-05-08</RequestDate>
            <Inquiry>Please update to the correct expense category</Inquiry>
            <Response>Done!</Response>
            <ResponseDate>2023-05-09</ResponseDate>
        </Inquiry>
    </Inquiries>
    <Notes>
        <Note>
            <SubmitterID>5bc30a6d-bb8c-4361-8f2a-8592e54927f8</SubmitterID>
            <SubmitterFirstName>Steve</SubmitterFirstName>
            <SubmitterLastName>Manager</SubmitterLastName>
            <SubmitterEmail>SteveManager@Company.com</SubmitterEmail>
            <Date>2023-06-07</Date>
            <Note>Corrected expense category</Note>
            <Flagged>False</Flagged>
        </Note>
    </Notes>
    <MealAttendees />
    <DetailedMealAttendees />
  </Expense>
  <Expense>
    <ID>e373a213-1dd3-4e3d-83b7-786bd9a5e201</ID>
    <ExpenseReportID>9b7146b0-3e92-4745-babf-8bda8973238a</ExpenseReportID>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <Email>rrobot@certify.com</Email>
    <EmployeeID>rrobot002</EmployeeID>
    <DepartmentName>Marketing</DepartmentName>
    <DepartmentCode>02</DepartmentCode>
    <ExpenseType>Meals</ExpenseType>
    <ExpenseCategory>New Hire Lunch</ExpenseCategory>
    <ExpenseCategoryGLCode>01</ExpenseCategoryGLCode>
    <Amount>150</Amount>
    <Billable>false</Billable>
    <Reimbursable>false</Reimbursable>
    <ReimAmount>0</ReimAmount>
    <SubmittedAmount>0</SubmittedAmount>
    <ConvertedAmount>0</ConvertedAmount>
    <ConvertedReimAmount>0</ConvertedReimAmount>
    <ExchangeRate>1</ExchangeRate>
    <ExpenseDate>2016-06-22</ExpenseDate>
    <PostingDate />
    <LodgingCheckInDate />
    <LodgingCheckOutDate />
    <RentalPickUpDate />
    <RentalDropOffDate />
    <Vendor>Bingas</Vendor>
    <Location>Mountain View, CA</Location>
    <TravelFrom />
    <TravelTo />
    <MileageFrom />
    <MileageTo />
    <MileageUnits>0</MileageUnits>
    <ProcessedDate>2016-06-22</ProcessedDate>
    <Processed>true</Processed>
    <Currency>USD</Currency>
    <SubmittedCurrency />
    <ConvertedCurrency />
    <Reason>Airfare</Reason>
    <VATAmount>0</VATAmount>
    <HSTAmount>0</HSTAmount>
    <PSTAmount>0</PSTAmount>
    <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
    <ExpenseTextGLD1>Marketing Convention</ExpenseTextGLD1>
    <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
    <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
    <ExpenseReportGLD1Name>Surf and Turf</ExpenseReportGLD1Name>
    <ExpenseReportGLD1Code>st001</ExpenseReportGLD1Code>
    <ReceiptImageLink>{unique receipt image url}</ReceiptImageLink>
    <ReceiptID />
    <PaymentCardName>Company Mastercard</PaymentCardName>
    <CCLast>0005</CCLast>
    <CCTransactionID>000008806037561_20160622_150.00</CCTransactionID>
    <ExpenseCategoryID>a336e9a2-a2ab-4eda-b924-234d8fe146c2</ExpenseCategoryID>
    <TrueProcessedDate>2016-06-22</TrueProcessedDate>
    <Inquiries />
    <Notes />
    <MealAttendees />
    <DetailedMealAttendees>
        <MealAttendee>
            <FirstName>Robbie</FirstName>
            <LastName>The Robot</LastName>
            <Title />
            <Company />
            <Relation>Self</Relation>
        </MealAttendee>
        <MealAttendee>
            <FirstName>Steve</FirstName>
            <LastName>Manager</LastName>
            <Title>Manager</Title>
            <Company>TheCompany</Company>
            <Relation>Employee</Relation>
        </MealAttendee>
        <MealAttendee>
            <FirstName>John</FirstName>
            <LastName>NewHire</LastName>
            <Title>Employee</Title>
            <Company>TheCompany</Company>
            <Relation>Employee</Relation>
        </MealAttendee>
    </DetailedMealAttendees>
  </Expense>
</Expenses>
Fields
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.
Status Status of the expense (Wallet, Drafts, Pending, Completed)
LastAction Last action performed on the expense (None, Approved, Disapproved)
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.
ConvertedAmount Total amount of the expense in the submitting users default currency.
ConvertedReimAmount Reimbursable amount of the expense in the submitting users default currency.
ExchangeRate The exchange rate used to convert the expense to the submitter's default currency.
ExpenseDate The date/datetime of the expense (yyyy-MM-dd[ HH:mm:ss]).
PostingDate The posting date of the expense as supplied by credit card feed (yyyy-MM-dd[ HH:mm:ss]).
LodgingCheckInDate The lodging check in date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
LodgingCheckOutDate The lodging check out date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
RentalPickUpDate The rental pick up date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
RentalDropOffDate The rental drop off date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
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[ HH:mm:ss]).
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"
ConvertedCurrency Three letter code of the currency of the converted expense. 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.
MileageFrom The origin location for mileage-based expense categories.
MileageTo The destination location for mileage-based expense categories.
MileageDistance The total distance traveled for mileage-based expense categories. Unit type dependent on Mileage Rate (Miles, Kilometers)
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.
CCTransactionID The credit card transaction ID supplied by the financial institution.
ExpenseCategoryID A numeric unique identifier for the expense category of each returned expense.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
Inquiries An inquiry allows an approver to request specific information from the submitter, or to allow editing the submitted expense. (Object array)
 RequestorID Unique user ID for the inquiry requestor.
 RequestorFirstName First name of the inquiry requestor.
 RequestorLastName Last name of the inquiry requestor.
 RequestorEmail Email address of the inquiry requestor.
 RequestDate Date the requestor submitted the inquiry.
 Inquiry Requestor's inquiry message.
 Response Expense submitter's response.
 ResponseDate Date of expense submitter's response.
Notes An approver may add notes to an individual expense line. (Object array)
 SubmitterID Unique user ID for the note submitter.
 SubmitterFirstName First name of the note submitter.
 SubmitterLastName Last name of the note submitter.
 SubmitterEmail Submitter's email address.
 Date Creation date of the note.
 Note Content of the note added.
 Flagged True/False, if submitter flagged the expense item for review.
MealAttendees Attendee information for non-detailed attendee meal categories.
DetailedMealAttendees Detailed information about each attendee associated to the meal expense. (Object array)
 FirstName Attendee's first name.
 LastName Attendee's last name.
 Title Attendee's title.
 Company Attendee's company.
 Relation Relationship with expense submitter. Can be one of Self,Employee,Client/Customer,Prospect, Vendor, Other.
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
{
   "Expenses": [
    {
      "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.93,
      "Billable": false,
      "Reimbursable": true,
      "ReimAmount": 191.96,
      "SubmittedAmount": 0,
      "ConvertedAmount": 0,
      "ConvertedReimAmount": 0,
      "ExchangeRate": 1,
      "ExpenseDate": "2016-05-03",
      "PostingDate": "",
      "LodgingCheckInDate": "2016-05-01",
      "LodgingCheckOutDate": "2016-05-03",
      "RentalPickUpDate": "",
      "RentalDropOffDate": "",
      "Vendor": "Mountain View Hotel",
      "Location": "Mountain View, CA",
      "TravelFrom": "",
      "TravelTo": "",
      "MileageFrom": "",
      "MileageTo": "",
      "MileageUnits": "0.0",
      "ExpenseReportName": "Business Trip May 2016",
      "ExpenseReportApprovalCode": 52,
      "Status": "Completed",
      "LastAction": "Approved",
      "ProcessedDate": "2016-05-30",
      "Processed": true,
      "Currency": "USD",
      "SubmittedCurrency": "",
      "ConvertedCurrency": "",
      "Reason": "Hotel Stay",
      "VATAmount": 0,
      "HSTAmount": 0,
      "PSTAmount": 0,
      "ExpenseTextGLD1Label": "Text GLD Expense",
      "ExpenseTextGLD1": "business",
      "ExpenseTextGLD2Label": "Numbers Only GLD",
      "ExpenseTextGLD2": "123",
      "ExpenseReportGLD1Label": "Food",
      "ExpenseReportGLD1Name": "Apples and Oranges",
      "ExpenseReportGLD1Code": "A123",
      "ReceiptImageLink": "{unique receipt image url}",
      "ReceiptID": "",
      "PaymentCardName": "Company Visa",
      "CCLast": "0005",
      "CCTransactionID": "000008806037561_20160503_192.93",
      "ExpenseCategoryID": "a326e9a2-a2ab-4eda-b924-234d8fe146c2",
      "TrueProcessedDate": "2016-06-01",
      "Inquiries": [
          {
                "RequestorID": "22c7f339-ca6d-402e-a380-e0f86aea51dd"
                "RequestorFirstName": "Steve"
                "RequestorLastName": "Manager"
                "RequestorEmail": "SteveManager@Company.com"
                "RequestDate": "2023-05-08"
                "Inquiry": "Please update to the correct expense category"
                "Response": "Done!"
                "ResponseDate": "2023-05-09"
          }
      ],
      "Notes": [
          {
                "SubmitterID": "db43b478-4cc8-4152-99fa-af749d29f2a1"
                "SubmitterFirstName": "Steve"
                "SubmitterLastName": "Manager"
                "SubmitterEmail": "SteveManager@Company.com"
                "Date": "2023-06-07"
                "Note": "Corrected expense category"
                "Flagged": "False"
          }
      ],
      "MealAttendees": "",
      "DetailedMealAttendees": []
    }
  ]
}
<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.93</Amount>
    <Billable>false</Billable>
    <Reimbursable>true</Reimbursable>
    <ReimAmount>191.96</ReimAmount>
    <SubmittedAmount>0</SubmittedAmount>
    <ConvertedAmount>0</ConvertedAmount>
    <ConvertedReimAmount>0</ConvertedReimAmount>
    <ExchangeRate>1</ExchangeRate>
    <ExpenseDate>2016-05-03</ExpenseDate>
    <PostingDate />
    <LodgingCheckInDate>2016-05-01</LodgingCheckInDate>
    <LodgingCheckOutDate>2016-05-03</LodgingCheckOutDate>
    <RentalPickUpDate />
    <RentalDropOffDate />
    <Vendor>Mountain View Hotel</Vendor>
    <Location>Mountain View, CA</Location>
    <TravelFrom />
    <TravelTo />
    <MileageFrom />
    <MileageTo />
    <MileageUnits>0.0</MileageUnits>
    <ExpenseReportName>Business Trip May 2016</ExpenseReportName>
    <ExpenseReportApprovalCode>52</ExpenseReportApprovalCode>
    <Status>Completed</Status>
    <LastAction>Approved</LastAction>
    <ProcessedDate>2016-05-30</ProcessedDate>
    <Processed>true</Processed>
    <Currency>USD</Currency>
    <SubmittedCurrency />
    <ConvertedCurrency />
    <Reason>Hotel Stay</Reason>
    <VATAmount>0</VATAmount>
    <HSTAmount>0</HSTAmount>
    <PSTAmount>0</PSTAmount>
    <ExpenseTextGLD1Label>Text GLD Expense</ExpenseTextGLD1Label>
    <ExpenseTextGLD1>business</ExpenseTextGLD1>
    <ExpenseTextGLD2Label>Numbers Only GLD</ExpenseTextGLD2Label>
    <ExpenseTextGLD2>123</ExpenseTextGLD2>
    <ExpenseReportGLD1Label>Food</ExpenseReportGLD1Label>
    <ExpenseReportGLD1Name>Apples and Oranges</ExpenseReportGLD1Name>
    <ExpenseReportGLD1Code>A123</ExpenseReportGLD1Code>
    <ReceiptImageLink>{unique receipt image url}</ReceiptImageLink>
    <ReceiptID />
    <PaymentCardName>Company Visa</PaymentCardName>
    <CCLast>0005</CCLast>
    <CCTransactionID>000008806037561_20160503_192.93</CCTransactionID>
    <ExpenseCategoryID>a326e9a2-a2ab-4eda-b924-234d8fe146c2</ExpenseCategoryID>
    <TrueProcessedDate>2016-06-01</TrueProcessedDate>
    <Inquiries>
        <Inquiry>
            <RequestorID>c7d6cf50-029c-49c8-9a10-4f0d0c5dd802</RequestorID>
            <RequestorFirstName>Steve</RequestorFirstName>
            <RequestorLastName>Manager</RequestorLastName>
            <RequestorEmail>SteveManager@Company.com</RequestorEmail>
            <RequestDate>2023-05-08</RequestDate>
            <Inquiry>Please update to the correct expense category</Inquiry>
            <Response>Done!</Response>
            <ResponseDate>2023-05-09</ResponseDate>
        </Inquiry>
    </Inquiries>
    <Notes>
        <Note>
            <SubmitterID>06417214-c0e9-4f73-80eb-8683dde3610e</SubmitterID>
            <SubmitterFirstName>Steve</SubmitterFirstName>
            <SubmitterLastName>Manager</SubmitterLastName>
            <SubmitterEmail>SteveManager@Company.com</SubmitterEmail>
            <Date>2023-06-07</Date>
            <Note>Corrected expense category</Note>
            <Flagged>False</Flagged>
        </Note>
    </Notes>
    <MealAttendees />
    <DetailedMealAttendees />
  </Expense>
</Expenses>
Fields
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.
Status Status of the expense (Wallet, Drafts, Pending, Completed)
LastAction Last action performed on the expense (None, Approved, Disapproved)
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.
ConvertedAmount Total amount of the expense in the submitting users default currency.
ConvertedReimAmount Reimbursable amount of the expense in the submitting users default currency.
ExchangeRate The exchange rate used to convert the expense to the submitter's default currency.
ExpenseDate The date/datetime of the expense (yyyy-MM-dd[ HH:mm:ss]).
PostingDate The posting date of the expense as supplied by credit card feed (yyyy-MM-dd[ HH:mm:ss]).
LodgingCheckInDate The lodging check in date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
LodgingCheckOutDate The lodging check out date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
RentalPickUpDate The rental pick up date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
RentalDropOffDate The rental drop off date of the expense, if applicable (yyyy-MM-dd[ HH:mm:ss]).
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[ HH:mm:ss]).
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"
ConvertedCurrency Three letter code of the currency of the converted expense. 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.
MileageFrom The origin location for mileage-based expense categories.
MileageTo The destination location for mileage-based expense categories.
MileageDistance The total distance traveled for mileage-based expense categories. Unit type dependent on Mileage Rate (Miles, Kilometers)
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.
CCTransactionID The credit card transaction ID supplied by the financial institution.
ExpenseCategoryID A numeric unique identifier for the expense category of each returned expense.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
Inquiries An inquiry allows an approver to request specific information from the submitter, or to allow editing the submitted expense. (Object array)
 RequestorID Unique user ID for the inquiry requestor.
 RequestorFirstName First name of the inquiry requestor.
 RequestorLastName Last name of the inquiry requestor.
 RequestorEmail Email address of the inquiry requestor.
 RequestDate Date the requestor submitted the inquiry.
 Inquiry Requestor's inquiry message.
 Response Expense submitter's response.
 ResponseDate Date of expense submitter's response.
Notes An approver may add notes to an individual expense line. (Object array)
 SubmitterID Unique user ID for the note submitter.
 SubmitterFirstName First name of the note submitter.
 SubmitterLastName Last name of the note submitter.
 SubmitterEmail Submitter's email address.
 Date Creation date of the note.
 Note Content of the note added.
 Flagged True/False, if submitter flagged the expense item for review.
MealAttendees Attendee information for non-detailed attendee meal categories.
DetailedMealAttendees Detailed information about each attendee associated to the meal expense. (Object array)
 FirstName Attendee's first name.
 LastName Attendee's last name.
 Title Attendee's title.
 Company Attendee's company.
 Relation Relationship with expense submitter. Can be one of Self,Employee,Client/Customer,Prospect, Vendor, Other.
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)
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
clearcache query For improved efficiency, this endpoint caches results for 15 minutes. Include this parameter to refresh the cache and obtain updated values instantly. No string (1 to clear cache)
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>
Fields
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 (Max Length: 255) No string
Code body The internal code used to identify the expense report GLD in your organization. (Max Length: 255) No string
Description body The internal description for the expense report GLD. (Max Length: 2000) No string
Data body Used to store various internal code values 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",
      "Data": ""
    },
    {
      "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>
    <Data />
  </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>
Fields
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 (Max Length: 255) No string
Code body The internal code used to identify the expense report GLD in your organization. (Max Length: 255) No string
Description body The internal description for the expense report GLD. (Max Length: 2000) No string
Data body Used to store various internal code values 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",
    "Data": "",
    "Active": 1
  }

<ExpRptGLD>
  <Name>Lasagna</Name>
  <Code>LSGN</Code>
  <Description>Meat or vegetarian</Description>
  <Data />
  <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>
Fields
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>
Fields
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. Reports can also be viewed in the browser by logged in users. Use the following URL with an updated expense report GUID: https://expense.certify.com/ViewExpRpt.aspx?__GUID={Report ID} Appending '&pdf=1' to the end of the URL will return a PDF of the expense report. Example: https://expense.certify.com/ViewExpRpt.aspx?__GUID={Report ID}&pdf=1

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. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
enddate query Ending point for the processed date range. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
dateformat query The returned date/datetime format of all date values in the response. No string("date" for "yyyy-MM-dd" - default, "datetime" for "yyyy-MM-dd HH:mm:ss")
datetype query The type of date, accountant assigned or true action date of when the expense report was processed. No string(0 for accountant assigned processed date - default, 1 for true processed date when accountant processed the report )
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
processed query Invoice report has been processed No string (1 for yes - default, 0 for no, 2 for both)
reimbursed query Invoice report has been reimbursed No string (1 for yes, 0 for no, 2 for both - default)
reimbursedstartdate query Starting point for the report reimbursement process. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss optional.
reimbursedenddate query Ending point for the report reimbursement process. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss optional.
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.04,
      "Currency": "USD",
      "SubmittedDate": "2017-02-03",
      "ProcessedDate": "2017-02-03",
      "ApprovalCode": 19,
      "StartDate": "2017-01-01",
      "EndDate": "2017-01-31",
      "InvoiceReportName": "Utilities, January 2017",
      "APSyncComplete": true,
      "Reimbursed": true,
      "ReimbursedDate": "2017-02-12",
      "ReimbursementTransactionID": "Manual Pay",
      "TrueProcessedDate": "2017-02-03",
      "SettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    },
    {
      "ID": "a9109697-ew08-45f1-9338-994e046a07ed",
      "EmployeeDepartment": "General",
      "FirstName": "Robbie",
      "LastName": "The Robot",
      "EmployeeID": "rrobot002",
      "TotalAmount": 34.4,
      "Currency": "USD",
      "SubmittedDate": "2017-02-03",
      "ProcessedDate": "2017-03-03",
      "ApprovalCode": 23,
      "StartDate": "2017-02-01",
      "EndDate": "2017-02-28",
      "InvoiceReportName": "Office Supplies",
      "APSyncComplete": false,
      "Reimbursed": true,
      "ReimbursedDate": "2018-03-12",
      "ReimbursementTransactionID": "04252018165201",
      "TrueProcessedDate": "2018-03-12",
      "SettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    }
  ]
<InvoiceReports>
  <InvoiceReport>
    <ID>fdf32884-af87-4991-a7q4-3e574ea6be88</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeID>jcerti001</EmployeeID>
    <TotalAmount>292.04</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2017-02-03</SubmittedDate>
    <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>
    <Reimbursed>true</Reimbursed>
    <ReimbursedDate>2017-02-12</ReimbursedDate>
    <ReimbursementTransactionID>Manual Pay</ReimbursementTransactionID>
    <TrueProcessedDate>2017-02-03</TrueProcessedDate>
    <SettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</SettlementAccountID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </InvoiceReport>
  <InvoiceReport>
    <ID>a9109697-ew08-45f1-9338-994e046a07ed</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <EmployeeID>rrobot002</EmployeeID>
    <TotalAmount>34.4</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2017-02-03</SubmittedDate>
    <ProcessedDate>2017-03-03</ProcessedDate>
    <ApprovalCode>23</ApprovalCode>
    <StartDate>2017-02-01</StartDate>
    <EndDate>2017-02-28</EndDate>
    <InvoiceReportName>Office Supplies</InvoiceReportName>
    <APSyncComplete>false</APSyncComplete>
    <Reimbursed>true</Reimbursed>
    <ReimbursedDate>2018-03-12</ReimbursedDate>
    <ReimbursementTransactionID>04252018165201</ReimbursementTransactionID>
    <TrueProcessedDate>2018-03-12</TrueProcessedDate>
    <SettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</SettlementAccountID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </InvoiceReport>
</InvoiceReports>
Fields
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.
SubmittedDate The date the invoice report was submitted for approval (yyyy-MM-dd[ HH:mm:ss]).
Processed Indicates whether the invoice report has been processed. (true/false)
ProcessedDate Date on which the invoice report was processed. (yyyy-MM-dd[ HH:mm:ss])
ApprovalCode Approval code of the invoice report.
StartDate Start date of the invoice report. (yyyy-MM-dd[ HH:mm:ss])
EndDate End date of the invoice report. (yyyy-MM-dd[ HH:mm:ss])
InvoiceReportName Name of the invoice report.
APSyncComplete Indicates whether the invoice report has been synchronized with a third party AP system. (true/false)
Reimbursed Indicates whether the expense report has been reimbursed. (true/false)
ReimbursedDate Indicates date the expense report was reimbursed. (yyyy-MM-dd[ HH:mm:ss])
ReimbursementTransactionID The numeric ACH transaction ID or 'Manual Pay'.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
SettlementAccountID Unique ID of the receipt.
SettlementAccountName Name of the settlement account.
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",
      "TotalAmount": 292.04,
      "Currency": "USD",
      "SubmittedDate": "2017-02-03",
      "ProcessedDate": "2017-02-03",
      "ApprovalCode": 19,
      "StartDate": "2017-01-01",
      "EndDate": "2017-01-31",
      "InvoiceReportName": "Utilities, January 2017",
      "APSyncComplete": true,
      "Reimbursed": true,
      "ReimbursedDate": "2017-02-12",
      "ReimbursementTransactionID": "Manual Pay",
      "TrueProcessedDate": "2017-02-03",
      "SettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    }
<InvoiceReports>
  <InvoiceReport>
    <ID>fdf32884-af87-4991-a7q4-3e574ea6be88</ID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeID>jcerti001</EmployeeID>
    <TotalAmount>292.04</TotalAmount>
    <Currency>USD</Currency>
    <SubmittedDate>2017-02-03</SubmittedDate>
    <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>
    <Reimbursed>true</Reimbursed>
    <ReimbursedDate>2017-02-12</ReimbursedDate>
    <ReimbursementTransactionID>Manual Pay</ReimbursementTransactionID>
    <TrueProcessedDate>2017-02-03</TrueProcessedDate>
    <SettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</SettlementAccountID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </InvoiceReport>
</InvoiceReports>
Fields
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.
SubmittedDate The date the invoice report was submitted for approval (yyyy-MM-dd[ HH:mm:ss]).
ProcessedDate Date on which the invoice report was processed. (yyyy-MM-dd[ HH:mm:ss])
ApprovalCode Approval code of the invoice report.
StartDate Start date of the invoice report. (yyyy-MM-dd[ HH:mm:ss])
EndDate End date of the invoice report. (yyyy-MM-dd[ HH:mm:ss])
InvoiceReportName Name of the invoice report.
APSyncComplete Indicates whether the invoice report has been synchronized with a third party AP system. (true/false)
Reimbursed Indicates whether the expense report has been reimbursed. (true/false)
ReimbursedDate Indicates date the expense report was reimbursed. (yyyy-MM-dd[ HH:mm:ss])
ReimbursementTransactionID The numeric ACH transaction ID or 'Manual Pay'.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
SettlementAccountID Unique ID of the receipt.
SettlementAccountName Name of the settlement account.
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. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
enddate query Ending point for the processed date range. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
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": [
    {
      "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.93,
      "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": "{unique receipt image url}",
      "TrueProcessedDate": "2016-05-30"
    },
    {
      "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.55,
      "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": "{unique receipt image url}",
      "TrueProcessedDate": "2016-05-30"
    }
  ]
<InvoiceReports>
  <InvoiceReport>
    <InvoiceReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</InvoiceReportID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeEmail>jcerti@certify.com</EmployeeEmail>
    <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>
    <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
    <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
    <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
    <Amount>192.93</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-07-03</DueDate>
    <PONumber>867-5309</PONumber>
    <POName>Best Purchase Order Ever</POName>
    <InvoiceImageLink>{unique receipt image url}</InvoiceImageLink>
    <TrueProcessedDate>2016-05-30</TrueProcessedDate>
  </InvoiceReport>
  <InvoiceReport>
    <ID>e373a213-1dd3-4e3d-83b7-786bd9a5e201</ID>
    <InvoiceReportID>9b7146b0-3e92-4745-babf-8bda8973238a</InvoiceReportID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <EmployeeEmail>rrobot@certify.com</EmployeeEmail>
    <EmployeeID>rrobot002</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>
    <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
    <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
    <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
    <Amount>342.55</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-07-03</DueDate>
    <PONumber>867-5310</PONumber>
    <POName>2nd Best Purchase Order Ever</POName>
    <InvoiceImageLink>{unique receipt image url}</InvoiceImageLink>
    <TrueProcessedDate>2016-05-30</TrueProcessedDate>
  </InvoiceReport>
</InvoiceReports>
Fields
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[ HH:mm:ss])
InvoiceDate The date of the invoice. (yyyy-MM-dd[ HH:mm:ss])
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
VendorStateProvince
VendorPostalCode
VendorContactName
VendorCustomerAccountNumber
VendorTaxpayerID
Vendor1099
DueDate Invoice due date. (yyyy-MM-dd[ HH:mm:ss])
PONumber Invoice purchase order number.
POName Invoice purchase order name.
InvoiceImageLink The Certify URL provided to access the image of this invoice.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
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. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
enddate query Ending point for the processed date range. Excludes unprocessed reports. No string (yyyy-MM-dd[ HH:mm:ss]) - HH:mm:ss values are optional.
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
processed query Invoice report has been processed No string (1 for yes - default, 0 for no, 2 for both)
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
{
   "Invoices": [
    {
      "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.93,
      "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": "{unique receipt image url}",
      "TrueProcessedDate": "2016-05-30"
    },
    {
      "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.55,
      "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": "{unique receipt image url}",
      "TrueProcessedDate": "2016-05-30"
    }
  ]
<Invoices>
  <Invoice>
    <InvoiceReportID>fdf33884-af87-2891-a7d4-3e574ea6be88</InvoiceReportID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Jack</FirstName>
    <LastName>Certi</LastName>
    <EmployeeEmail>jcerti@certify.com</EmployeeEmail>
    <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>
    <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
    <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
    <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
    <Amount>192.93</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-07-03</DueDate>
    <PONumber>867-5309</PONumber>
    <POName>Best Purchase Order Ever</POName>
    <InvoiceImageLink>{unique receipt image url}</InvoiceImageLink>
    <TrueProcessedDate>2016-05-30</TrueProcessedDate>
  </Invoice>
  <Invoice>
    <ID>e373a213-1dd3-4e3d-83b7-786bd9a5e201</ID>
    <InvoiceReportID>9b7146b0-3e92-4745-babf-8bda8973238a</InvoiceReportID>
    <EmployeeDepartment>General</EmployeeDepartment>
    <FirstName>Robbie</FirstName>
    <LastName>The Robot</LastName>
    <EmployeeEmail>rrobot@certify.com</EmployeeEmail>
    <EmployeeID>rrobot002</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>
    <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
    <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
    <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
    <Amount>342.55</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-07-03</DueDate>
    <PONumber>867-5310</PONumber>
    <POName>2nd Best Purchase Order Ever</POName>
    <InvoiceImageLink>{unique receipt image url}</InvoiceImageLink>
    <TrueProcessedDate>2016-05-30</TrueProcessedDate>
  </Invoice>
</Invoices>
Fields
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[ HH:mm:ss])
InvoiceDate The date of the invoice. (yyyy-MM-dd[ HH:mm:ss])
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[ HH:mm:ss])
PONumber Invoice purchase order number.
POName Invoice purchase order name.
InvoiceImageLink The Certify URL provided to access the image of this invoice.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
GET
/invoices/{id}
Expand Method
Description

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
{
   "Invoices": [
    {
      "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.93,
      "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": "{unique receipt image url}",
      "TrueProcessedDate": "2016-05-30"
    }
<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</EmployeeEmail>
    <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>
    <InvoiceReportGLD1Label>Food</InvoiceReportGLD1Label>
    <InvoiceReportGLD1Name>Apples and Oranges</InvoiceReportGLD1Name>
    <InvoiceReportGLD1Code>A123</InvoiceReportGLD1Code>
    <Amount>192.93</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-07-03</DueDate>
    <PONumber>867-5309</PONumber>
    <POName>Best Purchase Order Ever</POName>
    <InvoiceImageLink>{unique receipt image url}</InvoiceImageLink>
    <TrueProcessedDate>2016-05-30</TrueProcessedDate>
  </Invoice>
</Invoices>
Fields
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).
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).
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[ HH:mm:ss])
InvoiceDate The date of the invoice. (yyyy-MM-dd[ HH:mm:ss])
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[ HH:mm:ss])
PONumber Invoice purchase order number.
POName Invoice purchase order name.
InvoiceImageLink The Certify URL provided to access the image of this invoice.
TrueProcessedDate The date/datetime that an accountant physically processsed a report.
GET
/mileageratedetails
Expand Method
Description

This method returns a list of one or more mileage rate detail 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
effectivedatestart query Starting point for the mileage rate detail effective date. No string
effectivedateend query Ending point for the mileage rate detail effective date.. No string
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
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
{
   "MileageRateDetails": [
    {
      "ID": "6328e8b6-152e-495f-8cdb-76d52fce8c6f",
      "MileageRateID": "3e739178-3b4c-4eec-9260-2fbd181e1889",
      "EffectiveDate": "2018-01-01",
      "MileageRateCurrency": "USD",
      "DistanceUnits": "mi",
      "PrimaryRate": 0.5,
      "SecondaryRate": 0,
      "SecondaryRateThreshold": 0,
      "TertiaryRate": 0,
      "TertiaryRateThreshold": 0,
      "QuaternnaryRate": 0,
      "QuaternnaryRateThreshold": 0
    },
    {
      "ID": "22490018-2f01-44f8-b787-ced103fcb130",
      "MileageRateID": "3e739178-3b4c-4eec-9260-2fbd181e1889",
      "EffectiveDate": "2019-01-01",
      "MileageRateCurrency": "USD",
      "DistanceUnits": "mi",
      "PrimaryRate": 0.5,
      "SecondaryRate": 0.4,
      "SecondaryRateThreshold": 1000,
      "TertiaryRate": 0,
      "TertiaryRateThreshold": 0,
      "QuaternnaryRate": 0,
      "QuaternnaryRateThreshold": 0
    }
  ]
<MileageRateDetails>
  <Result>
    <ID>6328e8b6-152e-495f-8cdb-76d52fce8c6f</ID>
    <MileageRateID>3e739178-3b4c-4eec-9260-2fbd181e1889</MileageRateID>
    <EffectiveDate>2018-01-01</EffectiveDate>
    <MileageRateCurrency>USD</MileageRateCurrency>
    <DistanceUnits>mi</DistanceUnits>
    <PrimaryRate>0.5</PrimaryRate>
    <SecondaryRate>0</SecondaryRate>
    <SecondaryRateThreshold>0</SecondaryRateThreshold>
    <TertiaryRate>0</TertiaryRate>
    <TertiaryRateThreshold>0</TertiaryRateThreshold>
    <QuaternnaryRate>0</QuaternnaryRate>
    <QuaternnaryRateThreshold>0</QuaternnaryRateThreshold>
  </Result>
  <Result>
    <ID>22490018-2f01-44f8-b787-ced103fcb130</ID>
    <MileageRateID>3e739178-3b4c-4eec-9260-2fbd181e1889</MileageRateID>
    <EffectiveDate>2019-01-01</EffectiveDate>
    <MileageRateCurrency>USD</MileageRateCurrency>
    <DistanceUnits>mi</DistanceUnits>
    <PrimaryRate>0.5</PrimaryRate>
    <SecondaryRate>0.4</SecondaryRate>
    <SecondaryRateThreshold>1000</SecondaryRateThreshold>
    <TertiaryRate>0</TertiaryRate>
    <TertiaryRateThreshold>0</TertiaryRateThreshold>
    <QuaternnaryRate>0</QuaternnaryRate>
    <QuaternnaryRateThreshold>0</QuaternnaryRateThreshold>
  </Result>
</MileageRateDetails>
Fields
Field Value Description
MileageRateID Unique ID of the mileage rate detail record
Name The mileage rate ID
EffectiveDate The date upon which the rate will take effect
MileageRateCurrency Three letter code of the currency of the invoice report. ISO 4217 format
DistanceUnits The mileage unit of measure (mi or km)
PrimaryRate The primary mileage rate
SecondaryRate The secondary mileage rate
SecondaryRateThreshold The number of miles/kilometers upon which the secondary rate is applied
TertiaryRate The tertiary mileage rate
TertiaryRateThreshold The number of miles/kilometers upon which the tertiary rate is applied
QuaternaryRate The quaternary mileage rate
QuaternaryRateThreshold The number of miles/kilometers upon which the quaternary rate is applied
PUT
/mileageratedetails
Expand Method
Description

This method creates a new mileage rate detail record for the user’s company. Detail records can only be added if the parent mileage rate has a FederalMileageRateType of 0 (None). Certify automatically updates the United States Federal rates as they change over time. You may overwrite an existing mileage rate detail record by sending a request with a matching MileageRateID and EffectiveDate (as in the example below).

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
MileageRateID body The mileage rate ID Yes string
EffectiveDate body The date upon which the rate will take effect Yes string
MileageRateCurrency body Three letter code of the currency of the mileage rates. ISO 4217 format Yes string
DistanceUnits body The mileage unit of measure (mi or km) Yes string
PrimaryRate body The primary rate Yes string
SecondaryRate body The secondary rate. Required if a tertiary rate is to be supplied. No* string
SecondaryRateThreshold body The number of miles/kilometers upon which the secondary rate is applied. Required if a secondary rate is supplied. No* string
TertiaryRate body The tertiary rate. Required if a quaternary rate is to be supplied. No* string
TertiaryRateThreshold body The number of miles/kilometers upon which the tertiary rate is applied. Required if a tertiary rate is supplied. No* string
QuaternaryRate body The quaternary rate No string
QuaternaryRateThreshold body The number of miles/kilometers upon which the quaternary rate is applied. Required if a quaternary rate is supplied. No* string
Example Request
JSON XML

  {
    "MileageRateID": "3e739178-3b4c-4eec-9260-2fbd181e1889",
    "EffectiveDate": "2019-01-01",
    "MileageRateCurrency": "USD",
    "DistanceUnits": "mi",
    "PrimaryRate": 0.5,
    "SecondaryRate": 0.4,
    "SecondaryRateThreshold": 1000,
    "TertiaryRate": 0.3,
    "TertiaryRateThreshold": 2000,
    "QuaternaryRate": 0.2,
    "QuaternaryRateThreshold": 3000
  }

<MileageRateDetails>
  <MileageRateID>3e739178-3b4c-4eec-9260-2fbd181e1889</MileageRateID>
  <EffectiveDate>2019-01-01</EffectiveDate>
  <MileageRateCurrency>USD</MileageRateCurrency>
  <DistanceUnits>mi</DistanceUnits>
  <PrimaryRate>0.5</PrimaryRate>
  <SecondaryRate>0.4</SecondaryRate>
  <SecondaryRateThreshold>1000</SecondaryRateThreshold>
  <TertiaryRate>0.3</TertiaryRate>
  <TertiaryRateThreshold>2000</TertiaryRateThreshold>
  <QuaternaryRate>0.2</QuaternaryRate>
  <QuaternaryRateThreshold>3000</QuaternaryRateThreshold>
</MileageRateDetails>
Response

If successful, this method should return the ID of the new mileage rate detail record.

Example Response
JSON XML

  {
    "ID": "321065e9-aa0c-4801-8473-f65f87a5c1f4"
  }

  <ID>321065e9-aa0c-4801-8473-f65f87a5c1f4</ID>
Fields
Field Value Description
ID Unique ID of the mileage rate detail record
GET
/mileagerates
Expand Method
Description

This method returns a list of one or more mileage rates 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 mileage rate No string
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
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
{
   "MileageRates": [
    {
      "ID": "f3070edf-2f5a-417e-8225-237491352ee8",
      "Name": "Default",
      "FederalMileageRateType": 1,
      "ExpenseCategoryID": ""
    },
    {
      "ID": "3e739178-3b4c-4eec-9260-2fbd181e1889",
      "Name": "Mileage Rate",
      "FederalMileageRateType": 0,
      "ExpenseCategoryID": "3be13a87-ef04-4e08-89ae-6e6d450bcdb6"
    }
  ]
<MileageRates>
  <MileageRate>
    <ID>f3070edf-2f5a-417e-8225-237491352ee8</ID>
    <Name>Default</Name>
    <FederalMileageRateType>1</FederalMileageRateType>
    <ExpenseCategoryID />
  </MileageRate>
  <MileageRate>
    <ID>3e739178-3b4c-4eec-9260-2fbd181e1889</ID>
    <Name>Mileage Rate</Name>
    <FederalMileageRateType>0</FederalMileageRateType>
    <ExpenseCategoryID>3be13a87-ef04-4e08-89ae-6e6d450bcdb6</ExpenseCategoryID>
  </MileageRate>
</MileageRates>
Fields
Field Value Description
ID Unique ID of the mileage rate
Name Mileage rate name.
FederalMileageRateType Indicates the standard United States Federal mileage rate type (0 = None, 1 = Business, 2 = Medical and Moving, 3 = Charitable)
ExpenseCategoryID The expense category ID
POST
/mileagerates
Expand Method
Description

For each mileage rate element in the POST body, this method will update mileage rate 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 Mileage rate ID Yes string
Name body Mileage rate name (Max Length: 255) No string
FederalMileageRateType body Indicates the standard United States Federal mileage rate type (0 = None, 1 = Business, 2 = Medical and Moving, 3 = Charitable). A value of 0 would be used in conjunction with one or more custom mileage rate detail records. No string
ExpenseCategoryID body The expense category ID. If you want to set up multiple rates you can link this rate with an expense category. If you only need one rate you can leave this field blank. No string
Example Request
JSON XML
 [
    {
      "ID": "f3070edf-2f5a-417e-8225-237491352ee8",
      "Name": "Business",
      "FederalMileageRateType": 1,
      "ExpenseCategoryID": ""
    },
    {
      "ID": "3e739178-3b4c-4eec-9260-2fbd181e1889",
      "Name": "Custom Rate",
      "FederalMileageRateType": 0,
      "ExpenseCategoryID": "3be13a87-ef04-4e08-89ae-6e6d450bcdb6"
    }
  ]
<MileageRates>
  <MileageRate>
    <ID>f3070edf-2f5a-417e-8225-237491352ee8</ID>
    <Name>Business</Name>
    <FederalMileageRateType>1</FederalMileageRateType>
    <ExpenseCategoryID />
  </MileageRate>
  <MileageRate>
    <ID>3e739178-3b4c-4eec-9260-2fbd181e1889</ID>
    <Name>Custom Rate</Name>
    <FederalMileageRateType>0</FederalMileageRateType>
    <ExpenseCategoryID>3be13a87-ef04-4e08-89ae-6e6d450bcdb6</ExpenseCategoryID>
  </MileageRate>
</MileageRates>
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": " f3070edf-2f5a-417e-8225-237491352ee8",
      "Status": "Updated",
      "Message": ""
    },
    {
      "ID": "3e739178-3b4c-4eec-9260-2fbd181e1889",
      "Status": "Error",
      "Message": " ExpenseCategoryID is not a valid expense category ID."
    }
  ]
<Results>
  <Result>
    <ID> f3070edf-2f5a-417e-8225-237491352ee8</ID>
    <Status>Updated</Status>
    <Message />
  </Result>
  <Result>
    <ID>3e739178-3b4c-4eec-9260-2fbd181e1889</ID>
    <Status>Error</Status>
    <Message> ExpenseCategoryID is not a valid expense category ID.</Message>
  </Result>
</Results>
Fields
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
/mileagerates
Expand Method
Description

This method creates a new mileage rate 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
Name body Expense report GLD name (Max Length: 255) Yes string
FederalMileageRateType body Indicates the standard United States Federal mileage rate type (0 = None, 1 = Business, 2 = Medical and Moving, 3 = Charitable). A value of 0 would be used in conjunction with one or more custom mileage rate detail records. No string
ExpenseCategoryID body The expense category ID. If you want to set up multiple custom mileage rate detail records you can link this rate with an expense category. If you only need one rate you can leave this field blank. No string
Example Request
JSON XML

  {
    "Name": "Charitable",
    "FederalMileageRateType": 3,
    "ExpenseCategoryID": ""
  }

<MileageRate>
  <Name>Charitable</Name>
  <FederalMileageRateType>3</FederalMileageRateType>
  <ExpenseCategoryID />
</MileageRate>
Response

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

Example Response
JSON XML

  {
    "ID": "9a61cf7f-0bf7-425e-bc62-d85c5db7c88d"
  }

  <ID>9a61cf7f-0bf7-425e-bc62-d85c5db7c88d</ID>
Fields
Field Value Description
ID Unique ID of the new mileage rate.
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
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
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",
      "ExpenseIDs": "72a4f4ae-4929-4150-a2d7-e7542c7eaa8a|3e739178-3b4c-4eec-9260-2fbd181e1889"
    },
    {
      "ID": "03fa573c-b7f0-4398-b329-9f39a03dfb55",
      "Filename": "image2.jpg",
      "UploadDate": "2017-04-03",
      "ExpenseIDs": ""
    }
  ]
<Receipts>
  <Receipt>
    <ID>f86663bd-00b2-495c-ad77-2b6af37895aa</ID>
    <Filename>image.jpg</Filename>
    <UploadDate>2017-04-03</UploadDate>
    <ExpenseIDs>72a4f4ae-4929-4150-a2d7-e7542c7eaa8a|3e739178-3b4c-4eec-9260-2fbd181e1889</ExpenseIDs>
  </Receipt>
  <Receipt>
    <ID>03fa573c-b7f0-4398-b329-9f39a03dfb55</ID>
    <Filename>image2.jpg</Filename>
    <UploadDate>2017-04-03</UploadDate>
    <ExpenseIDs />
  </Receipt>
</Receipts>
Fields
Field Value Description
ID Unique ID of the receipt.
Filename Filename of the receipt.
UploadDate Date the receipt was uploaded to the wallet.
ExpenseIDs Pipe delimited list of ExpenseIDs associated to the receipt.
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
{
   "Receipts": [
    {
      "ID": "f86663bd-00b2-495c-ad77-2b6af37895aa",
      "Filename": "image.jpg",
      "UploadDate": "2017-04-03",
      "ReceiptImage": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
      "ExpenseIDs": "72a4f4ae-4929-4150-a2d7-e7542c7eaa8a"
    }
<Receipts>
  <Receipt>
    <ID>f86663bd-00b2-495c-ad77-2b6af37895aa</ID>
    <Filename>image.jpg</Filename>
    <UploadDate>2017-04-03</UploadDate>
    <ReceiptImage>/9j/4AAQSkZJRgABAQAAAQABAAD...</ReceiptImage>
    <ExpenseIDs>72a4f4ae-4929-4150-a2d7-e7542c7eaa8a</ExpenseIDs>
  </Receipt>
</Receipts>
Fields
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.
ExpenseIDs Pipe delimited list of ExpenseIDs associated to the receipt.
GET
/settlementaccounts
Expand Method
Description

This method returns a list of active settlement accounts.

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
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
{
   "SettlementAccounts": [
    {
      "ID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "SettlementAccountName": "Wells Fargo - UK"
    },
    {
      "ID": "fc6916c9-5df3-4d36-b6f8-d605ff64c0a3",
      "SettlementAccountName": "Bank of America - US"
    }
  ]
<SettlementAccounts>
  <SettlementAccount>
    <ID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</ID>
    <SettlementAccountName>Wells Fargo - UK</SettlementAccountName>
  </SettlementAccount>
  <SettlementAccount>
    <ID>fc6916c9-5df3-4d36-b6f8-d605ff64c0a3</ID>
    <SettlementAccountName>Bank of America - US</SettlementAccountName>
  </SettlementAccount>
</SettlementAccounts>
Fields
Field Value Description
ID Unique ID of the receipt.
SettlementAccountName Name of the settlement account.
GET
/users
Expand Method
Description

This method returns 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 (1 for active records, 0 for inactive, NULL for all)
role query Role name No string (‘Accountants’, ‘Employees’, ‘Executives’, ‘Guests’, ‘Managers’)
departmentid query Filters by users assigned to the unique department ID provided. No guid
empgld{i}id query Filters by users assigned to the unique employee GLD ID provided. Where {i} is the GLD index (1-5). No guid
page query Desired page of result No string (1 for page 1, 2 for page 2, n for page n)
clearcache query For improved efficiency, this endpoint caches results for 15 minutes. Include this parameter to refresh the cache and obtain updated values instantly. No string (1 to clear cache)
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",
      "UseMultipleCurrencies": 1,
      "LastModifiedDate": "2017-8-10",
      "WelcomeEmailSent": 1,
      "Active": 1,
      "FirstApproverID": "9ffe0981-5f56-4e87-ae39-5fbb583667f6",
      "SecondApproverID": "",
      "AccountantID": "31abf466-be2b-4f60-bc8f-845799ae6c59",
      "DefaultSettlementAccountID": "",
      "AdministrativeNotes": "Test user for documentation!"
    },
    {
      "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",
      "UseMultipleCurrencies": 0,
      "LastModifiedDate": "2018-7-21",
      "WelcomeEmailSent": 0,
      "Active": 0,
      "FirstApproverID": "",
      "SecondApproverID": "",
      "AccountantID": "",
      "DefaultSettlementAccountID": "51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed",
      "AdministrativeNotes": "None"
    }
  ]
<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>
    <UseMultipleCurrencies>1</UseMultipleCurrencies>
    <LastModifiedDate>2017-8-10</LastModifiedDate>
    <WelcomeEmailSent>1</WelcomeEmailSent>
    <Active>1</Active>
    <FirstApproverID>9ffe0981-5f56-4e87-ae39-5fbb583667f6</FirstApproverID>
    <SecondApproverID />
    <AccountantID>31abf466-be2b-4f60-bc8f-845799ae6c59</AccountantID>
    <DefaultSettlementAccountID />
    <AdministrativeNotes>Test user for documentation!</AdministrativeNotes>
  </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>
    <UseMultipleCurrencies>0</UseMultipleCurrencies>
    <LastModifiedDate>2018-7-21</LastModifiedDate>
    <WelcomeEmailSent>0</WelcomeEmailSent>
    <Active>0</Active>
    <FirstApproverID />
    <SecondApproverID />
    <AccountantID />
    <DefaultSettlementAccountID>51756fa9-cbc6-4b5a-bc81-cbc68e3eb0ed</DefaultSettlementAccountID>
    <AdministrativeNotes>None</AdministrativeNotes>
  </User>
</Users>
Fields
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
FirstApproverID First Approver ID for the user, if applicable. (Company configured for Locked Approval Workflow)
SecondApproverID Second Approver ID for the user, if applicable. (Company configured for Locked Approval Workflow)
AccountantID Accountant ID for the user, if applicable. (Company configured for Locked Approval Workflow)
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’)
UseMultipleCurrencies Indicates whether or not this user record uses multiple currencies
LastModifiedDate Date the user was last update (YYYY-MM-DD)
WelcomeEmailSent Indicates whether or not the user has been sent a welcome email. (1 = yes, 0 = no)
Active The active status of the user (1 = active, 0 = inactive)
AdministrativeNotes Private notes set by a Certify administrator or accountant for the user account.
PUT
/users
Expand Method
Description

This method creates a new user 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
Email body Email address (user name) (Max Length: 255) Yes string
Example Request
JSON XML

  {
    "Email": "davidsmith@circp.com"
  }

<Users>
  <Email>davidsmith@circp.com</Email>
</Users>
Response

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

Example Response
JSON XML

  {
    "ID": "321065e9-aa0c-4801-8473-f65f87a5c1f4"
  }

  <ID>321065e9-aa0c-4801-8473-f65f87a5c1f4</ID>
Fields
Field Value Description
ID Unique ID of the user record
POST
/users
Expand Method
Description

For each user element in the POST body, this method will update user 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 User ID Yes string
Email body The email address (user name) associated with this user record. (Max Length: 255) No string
FirstName body The first name associated with this user record. Required for user activation. (Max Length: 30) See Description string
LastName body The last name associated with this user record. Required for user activation. (Max Length: 30) See Description string
EmployeeID body The employee ID assocaited with this user record. (Max Length: 255) No string
MobilePhone body The mobile phone number associated with this user record. No string
Language body The two-character ISO language code associated with this user record. No string (ie: ‘de’)
Currency body The three-character ISO currency code associated with this user record. No string (ie: ‘USD’)
UseMultipleCurrencies body Indicates whether or not this user record uses multiple currencies No string (1 = yes, 0 = no)
DepartmentID body The department ID associated with this user record. Required for user activation. See Description string
Role body The user role associated with this user record. No string (‘Accountant’, ‘Employee’, ‘Executive’, ‘Manager’)
Treasurer body Indicates whether or not this user record is a Treasurer. No string (1 = yes, 0 = no)
FullAdministrator body Indicates whether or not this user record has access to all settings in the Configuration tab. No string (1 = yes, 0 = no)
UserAdministrator body Indicates whether or not this user record has access to view/edit user profiles in the Configuration tab; cannot use the "Switch to this User" function No string (1 = yes, 0 = no)
EmpGLD1ID body The Employee GLD1 ID associated with the user record. No string (NULL will remove associated value)
EmpGLD2ID body The Employee GLD2 ID associated with the user record. No string (NULL will remove associated value)
EmpGLD3ID body The Employee GLD3 ID associated with the user record. No string (NULL will remove associated value)
EmpGLD4ID body The Employee GLD4 ID associated with the user record. No string (NULL will remove associated value)
EmpGLD5ID body The Employee GLD5 ID associated with the user record. No string (NULL will remove associated value)
FirstApproverID body The user id of users default first approver (Only required if company is configured for Locked Approval Workflow) See Description string (NULL will remove associated value)
SecondApproverID body The user id of users default secondary approver (If company is configured for Locked Approval Workflow) No string (NULL will remove associated value)
AccountantID body The user id of users default accountant (If company is configured for Locked Approval Workflow) No string (NULL will remove associated value)
SendWelcomeEmail body Indicates whether to send a welcome email if user was able to succesfully be activated. (Action will reset users Certify password) No string (No = 0, Yes = 1, If not previously sent = 2)
Active body The active status of the user (1 = active, 0 = inactive). Users that do not meet requirements will be unable to be activated. No string
DefaultSettlementAccountID body The default Settlement Account ID associated with this user record. No string
AdministrativeNotes body Private note visibile by Certify Administrators and Accountants. No string
Example Request
JSON XML
 [
    {
      "ID": "321065e9-aa0c-4801-8473-f65f87a5c1f4",
      "Email": "davidsmith@circp.com",
      "FirstName": "David",
      "LastName": "Smith",
      "DepartmentID": "c456ab38-8f74-49e2-a47b-178f72c2f45f",
      "FirstApproverID": "e778f06d-9c47-41d7-80a0-7228d813bf22",
      "AccountantID": "31abf466-be2b-4f60-bc8f-845799ae6c59",
      "SendWelcomeEmail": 1,
      "Active": 1
    },
    {
      "ID": "31abf466-be2b-4f60-bc8f-845799ae6c59",
      "Role": "Director"
    }
  ]
<Users>
  <User>
    <ID>321065e9-aa0c-4801-8473-f65f87a5c1f4</ID>
    <Email>davidsmith@circp.com</Email>
    <FirstName>David</FirstName>
    <LastName>Smith</LastName>
    <DepartmentID>c456ab38-8f74-49e2-a47b-178f72c2f45f</DepartmentID>
    <FirstApproverID>e778f06d-9c47-41d7-80a0-7228d813bf22</FirstApproverID>
    <AccountantID>31abf466-be2b-4f60-bc8f-845799ae6c59</AccountantID>
    <SendWelcomeEmail>1</SendWelcomeEmail>
    <Active>1</Active>
  </User>
  <User>
    <ID>31abf466-be2b-4f60-bc8f-845799ae6c59</ID>
    <Role>Director</Role>
  </User>
</Users>
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": "321065e9-aa0c-4801-8473-f65f87a5c1f4",
      "Status": "Updated",
      "Message": ""
    },
    {
      "ID": "31abf466-be2b-4f60-bc8f-845799ae6c59",
      "Status": "Error",
      "Message": "Role 'Director' is not a valid User role."
    }
  ]
<Results>
  <Result>
    <ID>321065e9-aa0c-4801-8473-f65f87a5c1f4</ID>
    <Status>Updated</Status>
    <Message />
  </Result>
  <Result>
    <ID>31abf466-be2b-4f60-bc8f-845799ae6c59</ID>
    <Status>Error</Status>
    <Message>Role 'Director' is not a valid User role.</Message>
  </Result>
</Results>
Fields
Field Value Description
ID Unique ID of the User.
Status Returns status of "Updated" or "Error".
Message Detailed message when Status returns an "Error".
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
{
   "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",
      "UseMultipleCurrencies": 1,
      "LastModifiedDate": "2017-8-10",
      "WelcomeEmailSent": 1,
      "Active": 1,
      "FirstApproverID": "9ffe0981-5f56-4e87-ae39-5fbb583667f6",
      "SecondApproverID": "",
      "AccountantID": "31abf466-be2b-4f60-bc8f-845799ae6c59",
      "DefaultSettlementAccountID": "",
      "AdministrativeNotes": "Test user for documentation!"
    }
<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>
    <UseMultipleCurrencies>1</UseMultipleCurrencies>
    <LastModifiedDate>2017-8-10</LastModifiedDate>
    <WelcomeEmailSent>1</WelcomeEmailSent>
    <Active>1</Active>
    <FirstApproverID>9ffe0981-5f56-4e87-ae39-5fbb583667f6</FirstApproverID>
    <SecondApproverID />
    <AccountantID>31abf466-be2b-4f60-bc8f-845799ae6c59</AccountantID>
    <DefaultSettlementAccountID />
    <AdministrativeNotes>Test user for documentation!</AdministrativeNotes>
  </User>
</Users>
Fields
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
FirstApproverID First Approver ID for the user, if applicable. (Company configured for Locked Approval Workflow)
SecondApproverID Second Approver ID for the user, if applicable. (Company configured for Locked Approval Workflow)
AccountantID Accountant ID for the user, if applicable. (Company configured for Locked Approval Workflow)
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’)
UseMultipleCurrencies Indicates whether or not this user record uses multiple currencies
LastModifiedDate Date the user was last update (YYYY-MM-DD)
WelcomeEmailSent Indicates whether or not the user has been sent a welcome email. (1 = yes, 0 = no)
Active The active status of the user (1 = active, 0 = inactive)
AdministrativeNotes Private notes set by a Certify administrator or accountant for the user account.