> ## Documentation Index > Fetch the complete documentation index at: https://docs.upwell.com/llms.txt > Use this file to discover all available pages before exploring further. # Get One Vendor Invoice > Get a parsed vendor invoice by id, including line items, party addresses, and the matched purchase order. ## OpenAPI ````yaml /api-reference/openapi.json get /api/rest/vendor-invoices/{id} openapi: 3.1.0 info: description: >- Upwell is Accounts Receivable automation software for the logistics industry. We serve freight brokers, carriers, factors, and anyone who needs to get transportation invoices paid. Learn more at: - [Upwell.com](https://upwell.com) title: Upwell REST API version: 3.30.2 termsOfService: https://upwell.com/legal contact: name: Upwell url: https://upwell.com email: contact@upwell.com servers: - url: https://api.upwell.com description: Production server - url: https://staging.api.upwell.com description: Staging server security: [] tags: - name: Invoice Approval description: Endpoints for managing customer invoice approval workflow paths: /api/rest/vendor-invoices/{id}: get: tags: - Vendor Invoices summary: Get One Vendor Invoice description: >- Get a parsed vendor invoice by id, including line items, party addresses, and the matched purchase order. parameters: - description: >- Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY` in: header name: authorization schema: type: string - description: _"id" is required (enter it either in parameters or request body)_ in: path name: id schema: type: string required: true responses: '200': content: application/json: schema: properties: vendorInvoice: description: >- Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching nullable: true properties: accountNumber: nullable: true title: String type: string amountReceived: nullable: true title: Int type: integer annotations: items: description: Document Annotations nullable: false properties: confidence: nullable: false title: Int type: integer fieldLabel: nullable: true title: String type: string id: nullable: false title: String type: string markType: $ref: '#/components/schemas/SupportingDocsMarkTypeEnum' pageNumber: nullable: true title: Int type: integer reasoning: nullable: true title: String type: string stampTitle: nullable: true title: String type: string text: nullable: true title: String type: string type: $ref: >- #/components/schemas/SupportingDocsAnnotationTypeEnum valueDate: $ref: '#/components/schemas/date' valueNumber: nullable: true title: String type: string title: SupportingDocsDocumentAnnotations type: object nullable: false type: array billTo: description: Supporting Document Party nullable: true properties: address: description: columns and relationships of "addresses" nullable: true properties: city: nullable: true title: String type: string country: $ref: '#/components/schemas/CountryCodeEnum' stateOrProvince: nullable: true title: String type: string streetLine1: nullable: true title: String type: string streetLine2: nullable: true title: String type: string streetLine3: nullable: true title: String type: string zipOrPostalCode: nullable: true title: String type: string title: Addresses type: object email: nullable: true title: String type: string name: nullable: true title: String type: string phone: nullable: true title: String type: string title: SupportingDocsSupportingDocParty type: object createdAt: $ref: '#/components/schemas/timestamp' currency: $ref: '#/components/schemas/CurrencyCodeEnum' customerNumber: nullable: true title: String type: string department: nullable: true title: String type: string documentId: nullable: false title: String type: string dueDate: $ref: '#/components/schemas/date' fobPoint: nullable: true title: String type: string freightAmount: nullable: true title: Int type: integer id: nullable: false title: String type: string incoterms: nullable: true title: String type: string invoiceDate: $ref: '#/components/schemas/date' invoiceNumber: nullable: true title: String type: string legibilityScore: $ref: '#/components/schemas/numeric' matchedPurchaseOrder: description: >- Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation nullable: true properties: id: nullable: false title: String type: string poDate: $ref: '#/components/schemas/date' poNumber: nullable: true title: String type: string totalAmount: nullable: true title: Int type: integer title: SupportingDocsPurchaseOrders type: object matchedPurchaseOrderId: nullable: true title: String type: string notes: nullable: true title: String type: string orderDate: $ref: '#/components/schemas/date' paymentTermsDescription: nullable: true title: String type: string paymentTermsDiscountDays: nullable: true title: Int type: integer paymentTermsDiscountPercent: $ref: '#/components/schemas/numeric' paymentTermsNetDays: nullable: true title: Int type: integer poNumber: nullable: true title: String type: string projectNumber: nullable: true title: String type: string referenceNumbers: $ref: '#/components/schemas/jsonb' remitTo: description: Supporting Document Party nullable: true properties: address: description: columns and relationships of "addresses" nullable: true properties: city: nullable: true title: String type: string country: $ref: '#/components/schemas/CountryCodeEnum' stateOrProvince: nullable: true title: String type: string streetLine1: nullable: true title: String type: string streetLine2: nullable: true title: String type: string streetLine3: nullable: true title: String type: string zipOrPostalCode: nullable: true title: String type: string title: Addresses type: object email: nullable: true title: String type: string name: nullable: true title: String type: string phone: nullable: true title: String type: string title: SupportingDocsSupportingDocParty type: object requisitionerName: nullable: true title: String type: string salesOrderNumber: nullable: true title: String type: string shipTo: description: Supporting Document Party nullable: true properties: address: description: columns and relationships of "addresses" nullable: true properties: city: nullable: true title: String type: string country: $ref: '#/components/schemas/CountryCodeEnum' stateOrProvince: nullable: true title: String type: string streetLine1: nullable: true title: String type: string streetLine2: nullable: true title: String type: string streetLine3: nullable: true title: String type: string zipOrPostalCode: nullable: true title: String type: string title: Addresses type: object email: nullable: true title: String type: string name: nullable: true title: String type: string phone: nullable: true title: String type: string title: SupportingDocsSupportingDocParty type: object shipVia: nullable: true title: String type: string specialInstructions: nullable: true title: String type: string subtotalAmount: nullable: true title: Int type: integer surchargeAmount: nullable: true title: Int type: integer taxAmount: nullable: true title: Int type: integer taxExempt: nullable: true title: Boolean type: boolean totalAmount: nullable: true title: Int type: integer vendor: description: Supporting Document Party nullable: true properties: address: description: columns and relationships of "addresses" nullable: true properties: city: nullable: true title: String type: string country: $ref: '#/components/schemas/CountryCodeEnum' stateOrProvince: nullable: true title: String type: string streetLine1: nullable: true title: String type: string streetLine2: nullable: true title: String type: string streetLine3: nullable: true title: String type: string zipOrPostalCode: nullable: true title: String type: string title: Addresses type: object email: nullable: true title: String type: string name: nullable: true title: String type: string phone: nullable: true title: String type: string title: SupportingDocsSupportingDocParty type: object vendorInvoiceLineItems: items: description: >- Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent) nullable: false properties: chargeType: nullable: true title: String type: string customerPartNumber: nullable: true title: String type: string description: nullable: true title: String type: string discountPercent: $ref: '#/components/schemas/numeric' extendedAmount: nullable: true title: Int type: integer id: nullable: false title: String type: string lineNumber: nullable: true title: Int type: integer notes: nullable: true title: String type: string poLineNumber: nullable: true title: String type: string poNumber: nullable: true title: String type: string quantity: $ref: '#/components/schemas/numeric' quantityBackordered: $ref: '#/components/schemas/numeric' quantityOrdered: $ref: '#/components/schemas/numeric' quantityShipped: $ref: '#/components/schemas/numeric' taxAmount: nullable: true title: Int type: integer taxable: nullable: true title: Boolean type: boolean unitOfMeasure: nullable: true title: String type: string unitPriceAmount: nullable: true title: Int type: integer unitPriceBasis: $ref: '#/components/schemas/numeric' vendorPartNumber: nullable: true title: String type: string weight: $ref: '#/components/schemas/numeric' weightUnit: nullable: true title: String type: string title: SupportingDocsVendorInvoiceLineItems type: object nullable: false type: array title: SupportingDocsVendorInvoices type: object description: Responses for GET /api/rest/vendor-invoices/{id} components: schemas: SupportingDocsMarkTypeEnum: enum: - MARK - SIGNATURE nullable: false title: SupportingDocsMarkTypeEnum SupportingDocsAnnotationTypeEnum: enum: - DIGITAL - HANDWRITTEN - STAMP - TYPED nullable: false title: SupportingDocsAnnotationTypeEnum date: nullable: false title: date type: string format: date description: A date string, such as 2024-02-03 (YYYY-MM-DD) CountryCodeEnum: enum: - AD - AE - AF - AG - AL - AM - AO - AR - AT - AU - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BN - BO - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CL - CM - CN - CO - CR - CU - CV - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FM - FR - GA - GB - GD - GE - GH - GM - GN - GQ - GR - GT - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IN - IQ - IR - IS - IT - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - MK - ML - MM - MN - MO - MR - MT - MU - MV - MW - MX - MY - MZ - NA - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PG - PH - PK - PL - PR - PS - PT - PW - PY - QA - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SI - SK - SL - SM - SN - SO - SR - SS - ST - SV - SY - SZ - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VN - VU - WS - YE - ZA - ZM - ZW nullable: false title: CountryCodeEnum timestamp: nullable: false title: timestamp CurrencyCodeEnum: enum: - AED - AUD - BRL - CAD - CHF - CNY - EGP - EUR - GBP - HKD - IDR - INR - JPY - KRW - MXN - MYR - NZD - QAR - SAR - SGD - THB - TRY - TWD - USD - VND - ZAR nullable: false title: CurrencyCodeEnum numeric: nullable: false title: numeric jsonb: nullable: false title: jsonb ````