--- title: "Get a bill" method: GET path: "/v1/web/bill/{id}" tags: ["Bill"] --- # Get a bill `GET /v1/web/bill/{id}` ## Path parameters - `id` string, required ## Response `200` Default Response - object - `id` string, required - `externalId` string - `status` union, required - 'draft' - 'submitted' - 'returned' - 'paymentPending' - 'paymentInProgress' - 'paid' - 'paymentFailed' - 'manuallyCompleted' - 'deleted' - `creatorUserId` string, required - `vendorId` string - `invoiceId` string - `currencyCode` string - `invoiceDate` string, date — ISO date string, YYYY-MM-DD - `paymentDueDate` string, date — The date that the invoice says the payment is due, in ISO date string, YYYY-MM-DD - `totalAmount` string — number string - `description` string - `lineItems` object[], required - `id` string, required - `description` string - `amount` string, required — Number string - `spendCategoryId` string - `documents` object[], required - `id` string, required - `fileName` string, required - `type` union, required - 'invoice' - 'supporting' - `status` union, required - 'uploading' - 'uploaded' - 'parsed' - `parsedData` object - `invoiceId` string, nullable - `vendorName` string, nullable - `currencyCode` string, nullable - `invoiceDate` string, nullable — ISO date string, YYYY-MM-DD - `dueDate` string, nullable — ISO date string, YYYY-MM-DD - `totalAmount` string, nullable — Decimal string - `description` string, nullable - `achAccountName` string, nullable - `achRoutingNumber` string, nullable - `achAccountNumber` string, nullable - `lineItems` object[] - `description` string, nullable - `amount` string, nullable — Decimal string - `createdAt` string, date-time, required - `accountingIntegration` object - `rutterId` string - `platformId` string - `latestSync` object, required - `status` union, required - 'inProgress' - 'successful' - 'failed' - `createdAt` string, date-time, required - `completedAt` string, date-time - `error` object - `type` string - `code` string - `message` string - `source` string - `platformMessage` string - `paymentScheduledDate` string, date — When the payment will be triggered, in ISO date string, YYYY-MM-DD. It should be far enough in advance so when the payment reaches the vendor, it is still before or on the paymentDueDate. Date is based on the payment processor's timezone, i.e. EST. - `paymentRoute` union - union[] — Flat ordered array of hops the funds will travel through - union - object - `type` 'fundingAccount', required - `accountId` string, required - `id` string, required - object - `type` 'fundingSource', required - `accountId` string, required - `id` string, required - `speed` union, required - 'sameDay' - 'standard' - object - `type` 'singleUseCard', required - `accountId` string, required - `cardHolderId` string, required - `name` string, required - `cardProfileStrategy` union - 'advertising_least_used' - 'vertical_optimized' - 'shipping_optimized' - 'plastiq' - 'tokenizable' - object - `type` 'cashAdvance', required - `accountId` string, required - `repaymentSchedule` union, required - 'today' - 'net-1' - 'net-3' - 'net-7' - 'net-15' - 'net-20' - 'net-30' - 'net-45' - 'net-60' - 'net-90' - object - `type` 'fundingAccount', required - `accountId` string, required - `id` string, required - object - `type` 'achPaymentMethod', required - `id` string, required - `speed` union, required - 'sameDay' - 'standard' - `memo` string, required - object - `type` 'email', required - `sharedByName` string, required - `email` string, required - unknown[] - unknown - `remittanceNotification` object — Notifications when a bill is paid - `recipients` object[], required - `name` string, required - `email` string, required - `manualCompletion` object — Set when the bill was manually completed - `status` union, required - 'paid' - 'notPaid' - `reason` string - `purchaseOrder` union - object - `type` 'manual', required - `id` string, required - object - `type` 'rutter', required - `rutterId` string, required - `platformId` string, required - `accountingIntegration` object - `rutterId` string - `platformId` string - `latestSync` object, required - `status` union, required - 'inProgress' - 'successful' - 'failed' - `createdAt` string, date-time, required - `completedAt` string, date-time - `error` object - `type` string - `code` string - `message` string - `source` string - `platformMessage` string - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `submittedAt` string, date-time - `completedAt` string, date-time - `payment` object - `id` string, required — Reference ID for this payment - `externalId` string - `status` union, required - 'scheduled' - 'processing' - 'succeeded' - 'failed' - 'stopped' - 'deleted' - `creator` object, required - `type` 'bill', required - `id` string, required - `scheduledAt` string, date, required — ISO date string, YYYY-MM-DD - `legs` object[], required - `id` string, required - `type` union, required - 'debitAch' - 'creditAch' - 'emailSingleUseCard' - 'advanceCash' - `status` union, required - 'pending' - 'processing' - 'succeeded' - 'failed' - `source` union, required - object - `type` 'fundingAccount', required - `accountId` string, required - `id` string, required - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - object - `type` 'fundingSource', required - `accountId` string, required - `id` string, required - `speed` union, required - 'sameDay' - 'standard' - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - object - `type` 'singleUseCard', required - `accountId` string, required - `cardHolderId` string, required - `name` string, required - `cardProfileStrategy` union - 'advertising_least_used' - 'vertical_optimized' - 'shipping_optimized' - 'plastiq' - 'tokenizable' - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - object - `type` 'cashAdvance', required - `accountId` string, required - `repaymentSchedule` union, required - 'today' - 'net-1' - 'net-3' - 'net-7' - 'net-15' - 'net-20' - 'net-30' - 'net-45' - 'net-60' - 'net-90' - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - `target` union, required - object - `type` 'fundingAccount', required - `accountId` string, required - `id` string, required - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - object - `type` 'achPaymentMethod', required - `id` string, required - `speed` union, required - 'sameDay' - 'standard' - `memo` string, required - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - object - `type` 'email', required - `sharedByName` string, required - `email` string, required - `amount` object, required - `value` string, required — Decimal number string - `currencyCode` string, required - `fees` object - `value` string, required — Decimal number string - `currencyCode` string, required - `integration` union - object - `type` 'cfxDeposit', required - `id` string - `organizationId` string, required - `depositRequestId` string - `error` object - `code` string, required - `message` string, required - `details` object - object - `type` 'cfxWithdrawal', required - `id` string, required - `organizationId` string, required - `error` object - `code` string, required - `message` string, required - `details` object - object - `type` 'cardShare', required - `id` string, required - `cardSpendLimitRuleId` string - `cardShare` object - `id` string, required - `shareUrl` string, required - `expiresAt` string, date-time, required - `knockWorkflowRunId` string - `error` object - `code` string, required - `message` string, required - object - `type` 'cashAdvance', required - `id` string, required - `error` object - `code` string, required - `message` string, required - `startedAt` string, date-time - `completedAt` string, date-time - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `startedAt` string, date-time - `completedAt` string, date-time - `accountingIntegration` object - `rutterId` string - `platformId` string - `latestSync` object, required - `status` union, required - 'inProgress' - 'successful' - 'failed' - `createdAt` string, date-time, required - `completedAt` string, date-time - `error` object - `type` string - `code` string - `message` string - `source` string - `platformMessage` string - `canSubmitErrors` union[], required - union - object — A service error has occurred - `code` 'invalidStatus', required - `message` string, required - object — A service error has occurred - `code` 'invalidVendor', required - `message` string, required - object — A service error has occurred - `code` 'invalidInvoiceId', required - `message` string, required - object — A service error has occurred - `code` 'invalidCurrencyCode', required - `message` string, required - object — A service error has occurred - `code` 'invalidInvoiceDate', required - `message` string, required - object — A service error has occurred - `code` 'invalidPaymentScheduledDate', required - `message` string, required - object — A service error has occurred - `code` 'invalidPaymentRoute', required - `message` string, required - object — A service error has occurred - `code` 'invalidLineItems', required - `message` string, required - object — A service error has occurred - `code` 'invalidInvoice', required - `message` string, required - object — A service error has occurred - `code` 'invalidTotalAmount', required - `message` string, required ## Other responses - `400` — Default Response - `401` — The access to this resource has been denied - `403` — The access to this resource is forbidden - `404` — The resource was not found - `default` — Catch-all error response for any unexpected internal errors --- [API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/versions/ac700d65f443/schema)