US English (US)
AU English (AUS)

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
English (AUS)
US English (US)
AU English (AUS)
  • Home
  • Open API
  • Beta

Expense Management (Beta)

Endpoints for Expense Management such as Claims and Expenses

  • Open API

    • Webhooks

      • ERP Integration

        Content

        Claim finalisedDate (date) status (enum) Expense includePersonal (boolean) - false includeOmitted (boolean) - false

        Claim

        A claim is a request made by an employee for business expenses. The claim can originate from multiple sources including manually created reimbursements, credit card imports or virtual card transactions. The claim includes totals and summary details of the individual expenses.

        Endpoints

        GET /beta/company/{companyId}/claim

        GET /beta/company/{companyId}/claim/{claimId}

        Claim Object

        {
            "id": "3462",
            "createdOn": "1970-01-01T00:00:00Z",
            "approvedOn": "1970-01-01T00:00:00Z",
            "finalisedOn": "1970-01-01T00:00:00Z",
            "fromDate": "1970-01-01T00:00:00Z",
            "toDate": "1970-01-01T00:00:00Z",
            "claimantId": "4645",
            "claimantName": "Kylie Magenta",
            "summary": "",
            "description": "Reimbursement April",
            "total": {
        		"grossAmount": 141.03,
        		"netAmount": 128.21,
        		"taxAmount: 12.82,
        		"currency": "AUD"
        	},
            "approvers": [
                {
                    "id": "4709",
                    "name": "John Red"
                }
            ],
            "externalCode": "KMAGENTA",
            "employeeNumber": "E00012",
            "notes": "",
            "status": "Finalised", // None | NotSubmitted | PendingApproval | Approved | Finalised | Rejected
            "claimTypeId": 1,
            "customFields": [
                {
                    "type": "",
                    "name": "",
                    "value": ""
                }
            ]
        }

        Parameters

        finalisedDate (date)

        A filter for the finalised date of the claim, the results returned will be after or on the specified finalised date.

         
         

        status (enum)

        A filter on the status, if none provided all status will be included in the results.

         
         

         


        Expense

        Expenses, also referred to as transactions, are the individual expenses that are included in a specific claim. The expense includes the individual transaction details such as price, quantity, description, totals, as well as other data related to splits, allocations, and Fringe Benefit Tax (FBT).

        Endpoints

        GET /beta/company/{companyId}/claim/{claimId}/expense

        GET /beta/company/{companyId}/claim/{claimId}/expense/{expenseId}

        Expense Object

        {
            "id": "1234567",
            "createdOn": "1970-01-01T00:00:00Z",
            "code": "PRD1",
            "name": "Product 1",
            "isSplit": true,
            "splitChildren": ["1234567:456", "1234567:457"],
            "splitParent": "",
            "description": "",
            "quantity": 2,
            "amount": {
            	"grossUnitPrice": 0,
            	"netUnitPrice": 100,
        		"grossAmount": 0,
        		"netAmount": 0,
        		"taxAmount: 0,
        		"currency": "AUD"
        	},
            "taxCode": "GST",
            "entityId": "ENT1",
            "projectId": "PRJ001",
            "costCenterCode": "CC001",
            "glCode": "GL001",
            "externalCode": "",
            "isPersonal": false,
            "recipient": {
            	"type": "Guest",
            	"code": "",
            	"name": "Jane Doe",
            	"employeeId": "EM12345",
            	"employeeNumber": "HR12345",
            },
            "isOmitted": false,
            "notes": "",
            "claimTypeId": 1,
            "customFields": [
                {
                    "type": "",
                    "name": "",
                    "value": ""
                }
            ]
        }

        Parameters

        includePersonal (boolean) - false

        A filter for including personal expenses in the claim.

         
         

        includeOmitted (boolean) - false

        A filter for including omitted lines in the invoice, omitted lines are those that are excluded from the invoice totals and from approvals and workflows.

         
         

         

         

        expense claim fbt

        Related Articles

        • Accounts Payable (Beta)
        • Platform (Beta)
        logo for footer2-1

            (formerly expensemanager)

        U 110 , 4 Columbia Court,
        Norwest, NSW, 2153
        Australia
        Ph: +61 2 9672 6880 


        Products

        • Expenses
        • Budgets
        • Virtual Cards
        • Accounts Payable
        • Purchase Orders
        • Fringe Benefit Tax
        • eInvoicing
        • Travel Manager

        Quick Links

        • Book A Demo
        • Implementation
        • Integrations
        • Coming Soon
        • Our Partners
        • Privacy Policy
        • Contact Us

        Why ProSpend?

        • About Us
        • Meet the Team
        • Customer Stories
        • Careers

        Learn

        • Blog
        © 2023 ProSpend

        Knowledge Base Software powered by Helpjuice

        Expand