GET v1/bills/{id}

Gets bill details by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Provide Bill id to get details for

integer

Required

Body Parameters

None.

Response Information

Resource Description

Bill
NameDescriptionTypeAdditional information
Id

Read-only. Bill unique id - auto generated by the system.

integer

None.

TxnNumber

Read-only. Bill number - auto generated by the system.

string

None.

TxnDate

Date bill was issued.

date

Required

DueDate

Date bill is due. Either Due Date or Payment Term is required.

date

None.

PaymentTerm

Payment term which based on the TxnDate will calculate the DueDate. Either Due Date or Payment Term is required.

IdNamePair

None.

Vendor

The vendor for whom the bill is created for.

VendorRef

Required

VendorLocation

The vendor location for whom the bill is created for.

IdNamePair

None.

ShippingMethod

Shipping method for inventory items.

IdNamePair

None.

TrackingLink

Shipment tracking link.

string

None.

RequestedBy

The person who requested the bill.

IdNamePair

None.

ReferenceNumber

Bill reference number.

string

None.

Memo

Memo to provide additional information for the bill.

string

None.

BillTotal

Read-only. Total of bill.

decimal number

None.

OpenBalance

Read-only. The amount of the bill that has not been paid yet.

decimal number

None.

APGLAccount

Accounts Payable associated with the bill. Required when more than one AP account is available.

IdNamePair

None.

LineItemsGLCategory

GL category. Is only required if category tracking is turned on and is flagged as required.

IdNamePair

None.

Status

Read-only. The status of the bill.

IdNamePair

None.

IsItemReceipt

Indicates whether the transaction is a Bill or Item Receipt (Bill Pending).

boolean

None.

Currency

Read-only. Currency Information.

Currency

None.

LineItems

Bill line items: items and expenses.

Collection of BillLineItem

Required

NotesLogCount

Read-only. The number of notes logged to the bill.

integer

None.

AttachmentCount

Read-only. The number of attachments uploaded to the bill.

integer

None.

DateCreated

Read-only. The date and time (in company time zone) when the bill was created.

date

None.

CreatedBy

The person who created the bill.

IdNamePair

None.

LastUpdatedDate

Read-only. The date and time (in company time zone) when the bill was last updated.

date

None.

LastUpdatedBy

The person who last updated the bill.

IdNamePair

None.

Reviewed

Read-only. Indicates whether the bill has been reviewed or not.

boolean

None.

DateReviewed

Read-only. The date and time (in company time zone) when the bill was reviewed.

date

None.

ReviewedBy

Read-only. The person who reviewed the bill.

IdNamePair

None.

Format

The format for printing this bill. Default will be used if not passed. Not Required.

IdNamePair

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "txnNumber": "sample string 2",
  "txnDate": "2024-03-29T09:33:40.927933-04:00",
  "dueDate": "2024-03-29T09:33:40.927933-04:00",
  "paymentTerm": {
    "id": 1,
    "name": "sample string 2"
  },
  "vendor": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "vendorLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "shippingMethod": {
    "id": 1,
    "name": "sample string 2"
  },
  "trackingLink": "sample string 4",
  "requestedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "referenceNumber": "sample string 5",
  "memo": "sample string 6",
  "billTotal": 7.0,
  "openBalance": 8.0,
  "apglAccount": {
    "id": 1,
    "name": "sample string 2"
  },
  "lineItemsGLCategory": {
    "id": 1,
    "name": "sample string 2"
  },
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "isItemReceipt": true,
  "currency": {
    "currencyISOCode": "sample string 1",
    "exchangeRate": 2.0
  },
  "lineItems": [
    {
      "id": 1,
      "isExpense": true,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "glAccount": {
        "id": 1,
        "name": "sample string 2"
      },
      "qty": 3.0,
      "unitOfMeasure": {
        "extendedName": "sample string 1",
        "id": 2,
        "name": "sample string 3"
      },
      "cost": 4.0,
      "description": "sample string 5",
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "order": {
        "id": 1,
        "name": "sample string 2"
      },
      "purchaseOrderLineItemId": 6,
      "billable": true,
      "billed": true,
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "customColumns": [
        {
          "id": 1,
          "name": "sample string 2",
          "fieldType": {
            "id": 1,
            "name": "sample string 2"
          },
          "sourceId": 3,
          "value": "sample string 4",
          "valueText": "sample string 5",
          "isRequired": true
        },
        {
          "id": 1,
          "name": "sample string 2",
          "fieldType": {
            "id": 1,
            "name": "sample string 2"
          },
          "sourceId": 3,
          "value": "sample string 4",
          "valueText": "sample string 5",
          "isRequired": true
        }
      ]
    },
    {
      "id": 1,
      "isExpense": true,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "glAccount": {
        "id": 1,
        "name": "sample string 2"
      },
      "qty": 3.0,
      "unitOfMeasure": {
        "extendedName": "sample string 1",
        "id": 2,
        "name": "sample string 3"
      },
      "cost": 4.0,
      "description": "sample string 5",
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "order": {
        "id": 1,
        "name": "sample string 2"
      },
      "purchaseOrderLineItemId": 6,
      "billable": true,
      "billed": true,
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "customColumns": [
        {
          "id": 1,
          "name": "sample string 2",
          "fieldType": {
            "id": 1,
            "name": "sample string 2"
          },
          "sourceId": 3,
          "value": "sample string 4",
          "valueText": "sample string 5",
          "isRequired": true
        },
        {
          "id": 1,
          "name": "sample string 2",
          "fieldType": {
            "id": 1,
            "name": "sample string 2"
          },
          "sourceId": 3,
          "value": "sample string 4",
          "valueText": "sample string 5",
          "isRequired": true
        }
      ]
    }
  ],
  "notesLogCount": 10,
  "attachmentCount": 11,
  "dateCreated": "2024-03-29T09:33:40.927933-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2024-03-29T09:33:40.927933-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "reviewed": true,
  "dateReviewed": "2024-03-29T09:33:40.927933-04:00",
  "reviewedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "format": {
    "id": 1,
    "name": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<Bill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <APGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </APGLAccount>
  <AttachmentCount>11</AttachmentCount>
  <BillTotal>7</BillTotal>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <Currency xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_CurrencyISOCode_x003E_k__BackingField>sample string 1</d2p1:_x003C_CurrencyISOCode_x003E_k__BackingField>
    <d2p1:_x003C_ExchangeRate_x003E_k__BackingField>2</d2p1:_x003C_ExchangeRate_x003E_k__BackingField>
  </Currency>
  <DateCreated>2024-03-29T09:33:40.927933-04:00</DateCreated>
  <DateReviewed>2024-03-29T09:33:40.927933-04:00</DateReviewed>
  <DueDate>2024-03-29T09:33:40.927933-04:00</DueDate>
  <Format xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Format>
  <Id>1</Id>
  <IsItemReceipt>true</IsItemReceipt>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2024-03-29T09:33:40.927933-04:00</LastUpdatedDate>
  <LineItems>
    <BillLineItem>
      <Billable>true</Billable>
      <Billed>true</Billed>
      <Cost>4</Cost>
      <CustomColumns xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:CustomColumn>
          <d4p1:FieldType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:FieldType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsRequired>true</d4p1:IsRequired>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:SourceId>3</d4p1:SourceId>
          <d4p1:Value>sample string 4</d4p1:Value>
          <d4p1:ValueText>sample string 5</d4p1:ValueText>
        </d4p1:CustomColumn>
        <d4p1:CustomColumn>
          <d4p1:FieldType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:FieldType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsRequired>true</d4p1:IsRequired>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:SourceId>3</d4p1:SourceId>
          <d4p1:Value>sample string 4</d4p1:Value>
          <d4p1:ValueText>sample string 5</d4p1:ValueText>
        </d4p1:CustomColumn>
      </CustomColumns>
      <Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Customer>
      <Description>sample string 5</Description>
      <GLAccount xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLAccount>
      <GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLCategory>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <IsExpense>true</IsExpense>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
      <Order xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Order>
      <PurchaseOrderLineItemId>6</PurchaseOrderLineItemId>
      <Qty>3</Qty>
      <UnitOfMeasure xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>2</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 3</d4p1:_x003C_Name_x003E_k__BackingField>
        <d4p1:ExtendedName>sample string 1</d4p1:ExtendedName>
      </UnitOfMeasure>
    </BillLineItem>
    <BillLineItem>
      <Billable>true</Billable>
      <Billed>true</Billed>
      <Cost>4</Cost>
      <CustomColumns xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:CustomColumn>
          <d4p1:FieldType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:FieldType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsRequired>true</d4p1:IsRequired>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:SourceId>3</d4p1:SourceId>
          <d4p1:Value>sample string 4</d4p1:Value>
          <d4p1:ValueText>sample string 5</d4p1:ValueText>
        </d4p1:CustomColumn>
        <d4p1:CustomColumn>
          <d4p1:FieldType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:FieldType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsRequired>true</d4p1:IsRequired>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:SourceId>3</d4p1:SourceId>
          <d4p1:Value>sample string 4</d4p1:Value>
          <d4p1:ValueText>sample string 5</d4p1:ValueText>
        </d4p1:CustomColumn>
      </CustomColumns>
      <Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Customer>
      <Description>sample string 5</Description>
      <GLAccount xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLAccount>
      <GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLCategory>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <IsExpense>true</IsExpense>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
      <Order xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Order>
      <PurchaseOrderLineItemId>6</PurchaseOrderLineItemId>
      <Qty>3</Qty>
      <UnitOfMeasure xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>2</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 3</d4p1:_x003C_Name_x003E_k__BackingField>
        <d4p1:ExtendedName>sample string 1</d4p1:ExtendedName>
      </UnitOfMeasure>
    </BillLineItem>
  </LineItems>
  <LineItemsGLCategory xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LineItemsGLCategory>
  <Memo>sample string 6</Memo>
  <NotesLogCount>10</NotesLogCount>
  <OpenBalance>8</OpenBalance>
  <PaymentTerm xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </PaymentTerm>
  <ReferenceNumber>sample string 5</ReferenceNumber>
  <RequestedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </RequestedBy>
  <Reviewed>true</Reviewed>
  <ReviewedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ReviewedBy>
  <ShippingMethod xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ShippingMethod>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Status>
  <TrackingLink>sample string 4</TrackingLink>
  <TxnDate>2024-03-29T09:33:40.927933-04:00</TxnDate>
  <TxnNumber>sample string 2</TxnNumber>
  <Vendor xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </Vendor>
  <VendorLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </VendorLocation>
</Bill>