@rippling/rippling-sdk 0.2.0-alpha.107 → 0.2.0-alpha.108

package/resources/reimbursements.d.ts

@@ -0,0 +1,954 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Reimbursements extends APIResource {
+    /**
+     * A list of reimbursements.
+     *
+     * - Requires: `Internal Testing`
+     * - Filterable fields: `worker_id`, `transaction_date`, `entity_id`, `vendor_id`,
+     *   `category_id`
+     * - Sortable fields: `id`, `created_at`, `updated_at`, `transaction_date`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /reimbursements/?filter=filter&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "__meta": {
+     *     "redacted_fields": [
+     *       {
+     *         "name": "date_of_birth",
+     *         "reason": "Insufficient entitlements"
+     *       }
+     *     ]
+     *   },
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "worker_id": "string",
+     *       "company_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "merchant_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "transaction_date": "string",
+     *       "accounting_date": "string",
+     *       "gl_sync_state": "NOT_FINALIZED",
+     *       "approval_status": "DRAFT",
+     *       "entity_id": "string",
+     *       "vendor": {
+     *         "id": "string",
+     *         "name": "string"
+     *       },
+     *       "gl_vendor": {
+     *         "id": "string",
+     *         "name": "string",
+     *         "gl_vendor_id": "string"
+     *       },
+     *       "memo": "string",
+     *       "receipt": "string",
+     *       "attachments": [
+     *         "string"
+     *       ],
+     *       "line_items": [
+     *         {}
+     *       ],
+     *       "transaction_type": "REIMBURSEMENT",
+     *       "payout_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "payout_method": "NOT_SET",
+     *       "payout_date": "string",
+     *       "distance": 0,
+     *       "mileage_rate": {
+     *         "id": "string",
+     *         "name": "string",
+     *         "rate": {},
+     *         "units": "km"
+     *       },
+     *       "start_address": "string",
+     *       "end_address": "string",
+     *       "trip_start_date": "string",
+     *       "trip_end_date": "string",
+     *       "per_diem_rate": {
+     *         "id": "string",
+     *         "destination_name": "string",
+     *         "country": "string",
+     *         "currency": "string"
+     *       },
+     *       "per_diem_line_items": [
+     *         {}
+     *       ]
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
+     */
+    list(query?: ReimbursementListParams | null | undefined, options?: RequestOptions): PagePromise<ReimbursementListResponsesPageCursorURL, ReimbursementListResponse>;
+    /**
+     * Retrieve a specific reimbursement
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /reimbursements/{id}/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "__meta": {
+     *     "redacted_fields": [
+     *       {}
+     *     ]
+     *   }
+     * }
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<ReimbursementRetrieveResponse>;
+}
+export type ReimbursementListResponsesPageCursorURL = PageCursorURL<ReimbursementListResponse>;
+/**
+ * A Spend reimbursement the caller can see.
+ *
+ *     A reimbursement is an expense the worker paid and the company pays back. Mileage and per diem
+ *     use the same resource, with transaction_type MILEAGE_REIMBURSEMENT or PER_DIEM_REIMBURSEMENT.
+ *     Retrieve returns one by ID. A reimbursement the caller cannot see returns 404, the same as one
+ *     that does not exist.
+ */
+export interface ReimbursementListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Date the transaction is booked in the accounting system, as an ISO 8601 date
+     * (YYYY-MM-DD).
+     */
+    accounting_date?: string;
+    /**
+     * Approval status of the transaction. `DRAFT`: not submitted for approval.
+     * `PENDING`: awaiting required information or submission before approval.
+     * `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`:
+     * rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or
+     * reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null
+     * for card authorizations.
+     */
+    approval_status?: 'DRAFT' | 'PENDING' | 'REQUESTED' | 'APPROVED' | 'REJECTED' | 'FINALIZED' | 'ACTIONED' | 'CANCELLED' | 'FAILED';
+    /**
+     * URLs of other attached files.
+     */
+    attachments?: Array<string>;
+    /**
+     * Amount in the company's headquarters currency. The `value` is a decimal string.
+     */
+    company_amount?: ReimbursementListResponse.CompanyAmount;
+    /**
+     * Trip length in mileage_rate.units. Null except on mileage reimbursements.
+     */
+    distance?: number;
+    /**
+     * Mileage end address. Null when the trip has no end address.
+     */
+    end_address?: string;
+    /**
+     * ID of the legal entity the transaction belongs to. Use it with
+     * `/company-legal-entities/{id}/`.
+     */
+    entity_id?: string;
+    /**
+     * State of the sync to the accounting system. `NOT_FINALIZED`: not ready for
+     * accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`:
+     * sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync
+     * failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for
+     * accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to
+     * be synced automatically. Null when no sync state is set.
+     */
+    gl_sync_state?: 'NOT_FINALIZED' | 'FOR_REVIEW' | 'PENDING_SYNC' | 'SYNCED' | 'ERROR' | 'DO_NOT_SYNC' | 'EXPORTED' | 'NOT_SYNCABLE' | 'AUTO_SYNC';
+    /**
+     * Vendor in the connected accounting system.
+     */
+    gl_vendor?: ReimbursementListResponse.GlVendor;
+    /**
+     * Category splits of the transaction amount.
+     */
+    line_items?: Array<ReimbursementListResponse.LineItem>;
+    /**
+     * Memo entered on the transaction.
+     */
+    memo?: string;
+    /**
+     * Amount charged by the merchant, in the merchant currency. The `value` is a
+     * decimal string.
+     */
+    merchant_amount?: ReimbursementListResponse.MerchantAmount;
+    /**
+     * Company mileage rate. Null except on mileage reimbursements.
+     */
+    mileage_rate?: ReimbursementListResponse.MileageRate;
+    /**
+     * Amount credited to the worker. The `value` is a decimal string.
+     */
+    payout_amount?: ReimbursementListResponse.PayoutAmount;
+    /**
+     * Date the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is
+     * assigned.
+     */
+    payout_date?: string;
+    /**
+     * How the worker is paid. `NOT_SET`: no payout run is assigned. `US_PAYROLL`:
+     * assigned to a US payroll run. `GLOBAL_PAYROLL`: assigned to a global payroll
+     * run. `DIRECT_DEPOSIT`: assigned to a direct deposit run. `EOR`: assigned to an
+     * employer-of-record payroll run. `MANUAL`: marked paid outside a run. If a payout
+     * method override is set, it is returned.
+     */
+    payout_method?: 'NOT_SET' | 'GLOBAL_PAYROLL' | 'US_PAYROLL' | 'DIRECT_DEPOSIT' | 'EOR' | 'MANUAL';
+    /**
+     * Per diem sub-rate rows. Null except on per diem reimbursements.
+     */
+    per_diem_line_items?: Array<ReimbursementListResponse.PerDiemLineItem>;
+    /**
+     * Per diem rate for the trip. Null except on per diem reimbursements.
+     */
+    per_diem_rate?: ReimbursementListResponse.PerDiemRate;
+    /**
+     * URL of the receipt file.
+     */
+    receipt?: string;
+    /**
+     * Mileage start address. Null when the trip has no start address.
+     */
+    start_address?: string;
+    /**
+     * When the purchase or authorization happened, as an ISO 8601 date-time in UTC.
+     */
+    transaction_date?: string;
+    /**
+     * `REIMBURSEMENT`: an expense the worker paid and the company pays back.
+     * `MILEAGE_REIMBURSEMENT`: payback for distance driven. `PER_DIEM_REIMBURSEMENT`:
+     * payback for a daily travel allowance. This decides which mileage or per diem
+     * fields are set.
+     */
+    transaction_type?: 'REIMBURSEMENT' | 'MILEAGE_REIMBURSEMENT' | 'PER_DIEM_REIMBURSEMENT';
+    /**
+     * Per diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per
+     * diem reimbursements.
+     */
+    trip_end_date?: string;
+    /**
+     * Per diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per
+     * diem reimbursements.
+     */
+    trip_start_date?: string;
+    /**
+     * Vendor the purchase was made from.
+     */
+    vendor?: ReimbursementListResponse.Vendor;
+    /**
+     * ID of the worker who made the transaction. Use it with `/workers/{id}/`.
+     */
+    worker_id?: string;
+}
+export declare namespace ReimbursementListResponse {
+    /**
+     * Amount in the company's headquarters currency. The `value` is a decimal string.
+     */
+    interface CompanyAmount {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * Vendor in the connected accounting system.
+     */
+    interface GlVendor {
+        /**
+         * ID of the accounting vendor in Rippling.
+         */
+        id?: string;
+        /**
+         * ID of the vendor in the accounting system.
+         */
+        gl_vendor_id?: string;
+        /**
+         * Name of the vendor in the accounting system.
+         */
+        name?: string;
+    }
+    interface LineItem {
+        /**
+         * Amount of this split, in the merchant currency. The `value` is a decimal string.
+         */
+        amount?: LineItem.Amount;
+        /**
+         * ID of the Spend category assigned to this split. No public API is currently
+         * available to retrieve this category; its name is in `category_name`.
+         */
+        category_id?: string;
+        /**
+         * Name of the spend category.
+         */
+        category_name?: string;
+        /**
+         * Selected dimension values, keyed by dimension ID. Includes department and work
+         * location.
+         */
+        dimension_choices?: {
+            [key: string]: LineItem.DimensionChoices;
+        };
+        /**
+         * Whether this split is billed to `gl_customer` in the accounting system.
+         * `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not
+         * set.
+         */
+        gl_billable?: 'BILLABLE' | 'NOT_BILLABLE';
+        /**
+         * ID of the customer record in the connected accounting integration. No public
+         * Rippling API is currently available to retrieve this accounting customer.
+         */
+        gl_customer?: string;
+        /**
+         * Memo entered on this split.
+         */
+        memo?: string;
+    }
+    namespace LineItem {
+        /**
+         * Amount of this split, in the merchant currency. The `value` is a decimal string.
+         */
+        interface Amount {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        interface DimensionChoices {
+            /**
+             * Name of the dimension, such as Department.
+             */
+            dimension_name?: string;
+            /**
+             * Display name of the selected dimension value.
+             */
+            label?: string;
+            /**
+             * ID of the selected dimension value.
+             */
+            value?: string;
+        }
+    }
+    /**
+     * Amount charged by the merchant, in the merchant currency. The `value` is a
+     * decimal string.
+     */
+    interface MerchantAmount {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * Company mileage rate. Null except on mileage reimbursements.
+     */
+    interface MileageRate {
+        /**
+         * Company mileage rate ID.
+         */
+        id?: string;
+        /**
+         * Company-defined label for this mileage rate, such as the rate used for a country
+         * or vehicle type.
+         */
+        name?: string;
+        /**
+         * Amount per distance unit. The `value` is a decimal string.
+         */
+        rate?: MileageRate.Rate;
+        /**
+         * Distance unit, mi or km.
+         */
+        units?: 'km' | 'mi';
+    }
+    namespace MileageRate {
+        /**
+         * Amount per distance unit. The `value` is a decimal string.
+         */
+        interface Rate {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Amount credited to the worker. The `value` is a decimal string.
+     */
+    interface PayoutAmount {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    interface PerDiemLineItem {
+        /**
+         * Sub-rate amount for one unit. The `value` is a decimal string.
+         */
+        amount?: PerDiemLineItem.Amount;
+        /**
+         * amount times count. The `value` is a decimal string. Negative when line_type is
+         * EXCLUDE.
+         */
+        calculated_amount?: PerDiemLineItem.CalculatedAmount;
+        /**
+         * How many units.
+         */
+        count?: number;
+        /**
+         * Sub-rate label.
+         */
+        label?: string;
+        /**
+         * `INCLUDE`: this row is added to the reimbursement. `EXCLUDE`: this row is
+         * subtracted. `calculated_amount.value` is negative when excluded.
+         */
+        line_type?: 'INCLUDE' | 'EXCLUDE';
+        /**
+         * Per diem sub-rate ID.
+         */
+        sub_rate_id?: string;
+        /**
+         * `FULL_DAY`: the full daily allowance. `MEALS`: the meals portion of the daily
+         * allowance. `OTHERS`: an allowance that is not the full day or meals.
+         */
+        sub_rate_type?: 'FULL_DAY' | 'MEALS' | 'OTHERS';
+    }
+    namespace PerDiemLineItem {
+        /**
+         * Sub-rate amount for one unit. The `value` is a decimal string.
+         */
+        interface Amount {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * amount times count. The `value` is a decimal string. Negative when line_type is
+         * EXCLUDE.
+         */
+        interface CalculatedAmount {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Per diem rate for the trip. Null except on per diem reimbursements.
+     */
+    interface PerDiemRate {
+        /**
+         * Per diem rate ID.
+         */
+        id?: string;
+        /**
+         * Country this per diem rate applies to, as an ISO 3166-1 alpha-2 code. Example:
+         * US.
+         */
+        country?: string;
+        /**
+         * Currency of the per diem rate, as an ISO 4217 code. Example: USD.
+         */
+        currency?: string;
+        /**
+         * Place this per diem rate applies to, such as a city.
+         */
+        destination_name?: string;
+    }
+    /**
+     * Vendor the purchase was made from.
+     */
+    interface Vendor {
+        /**
+         * ID of the vendor.
+         */
+        id?: string;
+        /**
+         * Name of the vendor.
+         */
+        name?: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface ReimbursementRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Date the transaction is booked in the accounting system, as an ISO 8601 date
+     * (YYYY-MM-DD).
+     */
+    accounting_date?: string;
+    /**
+     * Approval status of the transaction. `DRAFT`: not submitted for approval.
+     * `PENDING`: awaiting required information or submission before approval.
+     * `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`:
+     * rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or
+     * reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null
+     * for card authorizations.
+     */
+    approval_status?: 'DRAFT' | 'PENDING' | 'REQUESTED' | 'APPROVED' | 'REJECTED' | 'FINALIZED' | 'ACTIONED' | 'CANCELLED' | 'FAILED';
+    /**
+     * URLs of other attached files.
+     */
+    attachments?: Array<string>;
+    /**
+     * Amount in the company's headquarters currency. The `value` is a decimal string.
+     */
+    company_amount?: ReimbursementRetrieveResponse.CompanyAmount;
+    /**
+     * Trip length in mileage_rate.units. Null except on mileage reimbursements.
+     */
+    distance?: number;
+    /**
+     * Mileage end address. Null when the trip has no end address.
+     */
+    end_address?: string;
+    /**
+     * ID of the legal entity the transaction belongs to. Use it with
+     * `/company-legal-entities/{id}/`.
+     */
+    entity_id?: string;
+    /**
+     * State of the sync to the accounting system. `NOT_FINALIZED`: not ready for
+     * accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`:
+     * sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync
+     * failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for
+     * accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to
+     * be synced automatically. Null when no sync state is set.
+     */
+    gl_sync_state?: 'NOT_FINALIZED' | 'FOR_REVIEW' | 'PENDING_SYNC' | 'SYNCED' | 'ERROR' | 'DO_NOT_SYNC' | 'EXPORTED' | 'NOT_SYNCABLE' | 'AUTO_SYNC';
+    /**
+     * Vendor in the connected accounting system.
+     */
+    gl_vendor?: ReimbursementRetrieveResponse.GlVendor;
+    /**
+     * Category splits of the transaction amount.
+     */
+    line_items?: Array<ReimbursementRetrieveResponse.LineItem>;
+    /**
+     * Memo entered on the transaction.
+     */
+    memo?: string;
+    /**
+     * Amount charged by the merchant, in the merchant currency. The `value` is a
+     * decimal string.
+     */
+    merchant_amount?: ReimbursementRetrieveResponse.MerchantAmount;
+    /**
+     * Company mileage rate. Null except on mileage reimbursements.
+     */
+    mileage_rate?: ReimbursementRetrieveResponse.MileageRate;
+    /**
+     * Amount credited to the worker. The `value` is a decimal string.
+     */
+    payout_amount?: ReimbursementRetrieveResponse.PayoutAmount;
+    /**
+     * Date the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is
+     * assigned.
+     */
+    payout_date?: string;
+    /**
+     * How the worker is paid. `NOT_SET`: no payout run is assigned. `US_PAYROLL`:
+     * assigned to a US payroll run. `GLOBAL_PAYROLL`: assigned to a global payroll
+     * run. `DIRECT_DEPOSIT`: assigned to a direct deposit run. `EOR`: assigned to an
+     * employer-of-record payroll run. `MANUAL`: marked paid outside a run. If a payout
+     * method override is set, it is returned.
+     */
+    payout_method?: 'NOT_SET' | 'GLOBAL_PAYROLL' | 'US_PAYROLL' | 'DIRECT_DEPOSIT' | 'EOR' | 'MANUAL';
+    /**
+     * Per diem sub-rate rows. Null except on per diem reimbursements.
+     */
+    per_diem_line_items?: Array<ReimbursementRetrieveResponse.PerDiemLineItem>;
+    /**
+     * Per diem rate for the trip. Null except on per diem reimbursements.
+     */
+    per_diem_rate?: ReimbursementRetrieveResponse.PerDiemRate;
+    /**
+     * URL of the receipt file.
+     */
+    receipt?: string;
+    /**
+     * Mileage start address. Null when the trip has no start address.
+     */
+    start_address?: string;
+    /**
+     * When the purchase or authorization happened, as an ISO 8601 date-time in UTC.
+     */
+    transaction_date?: string;
+    /**
+     * `REIMBURSEMENT`: an expense the worker paid and the company pays back.
+     * `MILEAGE_REIMBURSEMENT`: payback for distance driven. `PER_DIEM_REIMBURSEMENT`:
+     * payback for a daily travel allowance. This decides which mileage or per diem
+     * fields are set.
+     */
+    transaction_type?: 'REIMBURSEMENT' | 'MILEAGE_REIMBURSEMENT' | 'PER_DIEM_REIMBURSEMENT';
+    /**
+     * Per diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per
+     * diem reimbursements.
+     */
+    trip_end_date?: string;
+    /**
+     * Per diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per
+     * diem reimbursements.
+     */
+    trip_start_date?: string;
+    /**
+     * Vendor the purchase was made from.
+     */
+    vendor?: ReimbursementRetrieveResponse.Vendor;
+    /**
+     * ID of the worker who made the transaction. Use it with `/workers/{id}/`.
+     */
+    worker_id?: string;
+}
+export declare namespace ReimbursementRetrieveResponse {
+    /**
+     * Amount in the company's headquarters currency. The `value` is a decimal string.
+     */
+    interface CompanyAmount {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * Vendor in the connected accounting system.
+     */
+    interface GlVendor {
+        /**
+         * ID of the accounting vendor in Rippling.
+         */
+        id?: string;
+        /**
+         * ID of the vendor in the accounting system.
+         */
+        gl_vendor_id?: string;
+        /**
+         * Name of the vendor in the accounting system.
+         */
+        name?: string;
+    }
+    interface LineItem {
+        /**
+         * Amount of this split, in the merchant currency. The `value` is a decimal string.
+         */
+        amount?: LineItem.Amount;
+        /**
+         * ID of the Spend category assigned to this split. No public API is currently
+         * available to retrieve this category; its name is in `category_name`.
+         */
+        category_id?: string;
+        /**
+         * Name of the spend category.
+         */
+        category_name?: string;
+        /**
+         * Selected dimension values, keyed by dimension ID. Includes department and work
+         * location.
+         */
+        dimension_choices?: {
+            [key: string]: LineItem.DimensionChoices;
+        };
+        /**
+         * Whether this split is billed to `gl_customer` in the accounting system.
+         * `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not
+         * set.
+         */
+        gl_billable?: 'BILLABLE' | 'NOT_BILLABLE';
+        /**
+         * ID of the customer record in the connected accounting integration. No public
+         * Rippling API is currently available to retrieve this accounting customer.
+         */
+        gl_customer?: string;
+        /**
+         * Memo entered on this split.
+         */
+        memo?: string;
+    }
+    namespace LineItem {
+        /**
+         * Amount of this split, in the merchant currency. The `value` is a decimal string.
+         */
+        interface Amount {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        interface DimensionChoices {
+            /**
+             * Name of the dimension, such as Department.
+             */
+            dimension_name?: string;
+            /**
+             * Display name of the selected dimension value.
+             */
+            label?: string;
+            /**
+             * ID of the selected dimension value.
+             */
+            value?: string;
+        }
+    }
+    /**
+     * Amount charged by the merchant, in the merchant currency. The `value` is a
+     * decimal string.
+     */
+    interface MerchantAmount {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * Company mileage rate. Null except on mileage reimbursements.
+     */
+    interface MileageRate {
+        /**
+         * Company mileage rate ID.
+         */
+        id?: string;
+        /**
+         * Company-defined label for this mileage rate, such as the rate used for a country
+         * or vehicle type.
+         */
+        name?: string;
+        /**
+         * Amount per distance unit. The `value` is a decimal string.
+         */
+        rate?: MileageRate.Rate;
+        /**
+         * Distance unit, mi or km.
+         */
+        units?: 'km' | 'mi';
+    }
+    namespace MileageRate {
+        /**
+         * Amount per distance unit. The `value` is a decimal string.
+         */
+        interface Rate {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Amount credited to the worker. The `value` is a decimal string.
+     */
+    interface PayoutAmount {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    interface PerDiemLineItem {
+        /**
+         * Sub-rate amount for one unit. The `value` is a decimal string.
+         */
+        amount?: PerDiemLineItem.Amount;
+        /**
+         * amount times count. The `value` is a decimal string. Negative when line_type is
+         * EXCLUDE.
+         */
+        calculated_amount?: PerDiemLineItem.CalculatedAmount;
+        /**
+         * How many units.
+         */
+        count?: number;
+        /**
+         * Sub-rate label.
+         */
+        label?: string;
+        /**
+         * `INCLUDE`: this row is added to the reimbursement. `EXCLUDE`: this row is
+         * subtracted. `calculated_amount.value` is negative when excluded.
+         */
+        line_type?: 'INCLUDE' | 'EXCLUDE';
+        /**
+         * Per diem sub-rate ID.
+         */
+        sub_rate_id?: string;
+        /**
+         * `FULL_DAY`: the full daily allowance. `MEALS`: the meals portion of the daily
+         * allowance. `OTHERS`: an allowance that is not the full day or meals.
+         */
+        sub_rate_type?: 'FULL_DAY' | 'MEALS' | 'OTHERS';
+    }
+    namespace PerDiemLineItem {
+        /**
+         * Sub-rate amount for one unit. The `value` is a decimal string.
+         */
+        interface Amount {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+        /**
+         * amount times count. The `value` is a decimal string. Negative when line_type is
+         * EXCLUDE.
+         */
+        interface CalculatedAmount {
+            /**
+             * The currency type, ex: USD, EUR, etc.
+             */
+            currency_type?: string;
+            /**
+             * The decimal amount for the currency.
+             */
+            value?: number;
+        }
+    }
+    /**
+     * Per diem rate for the trip. Null except on per diem reimbursements.
+     */
+    interface PerDiemRate {
+        /**
+         * Per diem rate ID.
+         */
+        id?: string;
+        /**
+         * Country this per diem rate applies to, as an ISO 3166-1 alpha-2 code. Example:
+         * US.
+         */
+        country?: string;
+        /**
+         * Currency of the per diem rate, as an ISO 4217 code. Example: USD.
+         */
+        currency?: string;
+        /**
+         * Place this per diem rate applies to, such as a city.
+         */
+        destination_name?: string;
+    }
+    /**
+     * Vendor the purchase was made from.
+     */
+    interface Vendor {
+        /**
+         * ID of the vendor.
+         */
+        id?: string;
+        /**
+         * Name of the vendor.
+         */
+        name?: string;
+    }
+}
+export interface ReimbursementListParams {
+    cursor?: string;
+    filter?: string;
+    /**
+     * The maximum number of results to return. Defaults to 50. Maximum is 100.
+     */
+    limit?: number;
+    order_by?: string;
+}
+export declare namespace Reimbursements {
+    export { type ReimbursementListResponse as ReimbursementListResponse, type ReimbursementRetrieveResponse as ReimbursementRetrieveResponse, type ReimbursementListResponsesPageCursorURL as ReimbursementListResponsesPageCursorURL, type ReimbursementListParams as ReimbursementListParams, };
+}
+//# sourceMappingURL=reimbursements.d.ts.map