GET v1/bill-credits/{id}

Gets bill credit details by id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

BillCredit

Name	Description	Type	Additional information
Id	Read-only. Bill credit unique id - auto generated by the system.	integer	None.
TxnNumber	Credit number - auto generated by the system if not provided.	string	None.
TxnDate	Date credit was issued.	date	Required
Vendor	The vendor for whom the credit is created for.	VendorRef	Required
VendorLocation	The vendor location for whom the credit is created for.	IdNamePair	None.
Memo	Memo to provide additional information for the credit.	string	None.
Status	Read-only. The status of the bill credit.	IdNamePair	None.
CreditTotal	Read-only. Total of credit.	decimal number	None.
UnappliedCredit	Read-only. The amount of the credit that has not been applied 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.
LineItems	Credit line items: items and expenses.	Collection of BillCreditLineItem	Required
AppliedToBills	The bills the credit was applied to. This property is also designated to be used while creating a bill credit which will apply the credit to the specified bills.	Collection of AppliedToTxn	None.
NotesLogCount	Read-only. The number of notes logged to the bill.	integer	None.
AttachmentCount	Read-only. The number of attachments uploaded to the credit.	integer	None.
DateCreated	Read-only. The date and time (in company time zone) when the credit was created.	date	None.
CreatedBy	The person who created the credit.	IdNamePair	None.
LastUpdatedDate	Read-only. The date and time (in company time zone) when the credit was last updated.	date	None.
LastUpdatedBy	The person who last updated the credit.	IdNamePair	None.
Reviewed	Read-only. Indicates whether the credit has been reviewed or not.	boolean	None.
DateReviewed	Read-only. The date and time (in company time zone) when the credit was reviewed.	date	None.
ReviewedBy	Read-only. The person who reviewed the credit.	IdNamePair	None.
Currency	Read-only. Currency Information.	Currency	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "txnNumber": "sample string 2",
  "txnDate": "2024-04-24T13:34:25.808929-04:00",
  "vendor": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "vendorLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "memo": "sample string 4",
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "creditTotal": 5.0,
  "unappliedCredit": 6.0,
  "apglAccount": {
    "id": 1,
    "name": "sample string 2"
  },
  "lineItemsGLCategory": {
    "id": 1,
    "name": "sample string 2"
  },
  "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"
      },
      "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"
      },
      "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
        }
      ]
    }
  ],
  "appliedToBills": [
    {
      "txnId": 1,
      "amount": 2.0,
      "dateApplied": "2024-04-24T13:34:25.808929-04:00"
    },
    {
      "txnId": 1,
      "amount": 2.0,
      "dateApplied": "2024-04-24T13:34:25.808929-04:00"
    }
  ],
  "notesLogCount": 7,
  "attachmentCount": 8,
  "dateCreated": "2024-04-24T13:34:25.808929-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2024-04-24T13:34:25.808929-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "reviewed": true,
  "dateReviewed": "2024-04-24T13:34:25.808929-04:00",
  "reviewedBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "currency": {
    "currencyISOCode": "sample string 1",
    "exchangeRate": 2.0
  }
}

application/xml, text/xml

Sample:

<BillCredit 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>
  <AppliedToBills>
    <AppliedToTxn>
      <Amount>2</Amount>
      <DateApplied>2024-04-24T13:34:25.808929-04:00</DateApplied>
      <TxnId>1</TxnId>
    </AppliedToTxn>
    <AppliedToTxn>
      <Amount>2</Amount>
      <DateApplied>2024-04-24T13:34:25.808929-04:00</DateApplied>
      <TxnId>1</TxnId>
    </AppliedToTxn>
  </AppliedToBills>
  <AttachmentCount>8</AttachmentCount>
  <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>
  <CreditTotal>5</CreditTotal>
  <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-04-24T13:34:25.808929-04:00</DateCreated>
  <DateReviewed>2024-04-24T13:34:25.808929-04:00</DateReviewed>
  <Id>1</Id>
  <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-04-24T13:34:25.808929-04:00</LastUpdatedDate>
  <LineItems>
    <BillCreditLineItem>
      <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>
      <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>
    </BillCreditLineItem>
    <BillCreditLineItem>
      <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>
      <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>
    </BillCreditLineItem>
  </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 4</Memo>
  <NotesLogCount>7</NotesLogCount>
  <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>
  <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>
  <TxnDate>2024-04-24T13:34:25.808929-04:00</TxnDate>
  <TxnNumber>sample string 2</TxnNumber>
  <UnappliedCredit>6</UnappliedCredit>
  <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>
</BillCredit>