# Get bill

GET https://api-sandbox.payabli.com/api/Bill/{idBill}

Retrieves a bill by ID from an entrypoint.

Reference: https://docs.payabli.com/developers/api-reference/bill/get-bill

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get bill
  version: endpoint_bill.GetBill
paths:
  /Bill/{idBill}:
    get:
      operationId: get-bill
      summary: Get bill
      description: Retrieves a bill by ID from an entrypoint.
      tags:
        - - subpackage_bill
      parameters:
        - name: idBill
          in: path
          description: >-
            Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
            for the entrypoint or the organization.
          required: true
          schema:
            type: integer
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_bill:GetBillResponse'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:Responsecode:
      type: integer
    type_:PageIdentifier:
      type: string
    type_:RoomIdNotInUse:
      type: integer
      format: int64
    type_:IsSuccess:
      type: boolean
    type_:ResponseText:
      type: string
    type_:BillId:
      type: integer
      format: int64
    type_:Datenullable:
      type: string
      format: date
    type_:ItemCommodityCode:
      type: string
    type_:ItemDescription:
      type: string
    type_:ItemProductCode:
      type: string
    type_:ItemProductName:
      type: string
    type_:ItemUnitofMeasure:
      type: string
    type_:BillItem:
      type: object
      properties:
        itemCategories:
          type: array
          items:
            type: string
          description: Array of tags classifying item or product.
        itemCommodityCode:
          $ref: '#/components/schemas/type_:ItemCommodityCode'
        itemCost:
          type: number
          format: double
          description: Item or product price per unit.
        itemDescription:
          $ref: '#/components/schemas/type_:ItemDescription'
        itemMode:
          type: integer
          description: >-
            Internal class of item or product: value '0' is only for invoices ,
            '1' for bills and, '2' common for both.
        itemProductCode:
          $ref: '#/components/schemas/type_:ItemProductCode'
        itemProductName:
          $ref: '#/components/schemas/type_:ItemProductName'
        itemQty:
          type: integer
          description: Quantity of item or product.
        itemTaxAmount:
          type: number
          format: double
          description: Tax amount applied to item or product.
        itemTaxRate:
          type: number
          format: double
          description: Tax rate applied to item or product.
        itemTotalAmount:
          type: number
          format: double
          description: Total amount in item or product.
        itemUnitOfMeasure:
          $ref: '#/components/schemas/type_:ItemUnitofMeasure'
      required:
        - itemCost
    type_:Billitems:
      type: array
      items:
        $ref: '#/components/schemas/type_:BillItem'
    type_:AccountingField:
      type: string
    type_:Terms:
      type: string
    type_:AdditionalDataString:
      type: string
    type_:VendorNumber:
      type: string
    type_:Email:
      type: string
      format: email
    type_:Mcc:
      type: string
    type_:LocationCode:
      type: string
    type_:ContactsResponse:
      type: object
      properties:
        ContactEmail:
          $ref: '#/components/schemas/type_:Email'
          description: Contact email address.
        ContactName:
          type: string
          description: Contact name.
        ContactPhone:
          type: string
          description: Contact phone number.
        ContactTitle:
          type: string
          description: Contact title.
    type_:VendorResponseBillingData:
      type: object
      properties:
        id:
          type: integer
        accountId:
          type: string
        nickname:
          type: string
        bankName:
          type: string
        routingAccount:
          type: string
        accountNumber:
          type: string
        typeAccount:
          type: string
        bankAccountHolderName:
          type: string
        bankAccountHolderType:
          type: string
        bankAccountFunction:
          type: integer
        verified:
          type: boolean
        status:
          type: integer
        services:
          type: array
          items:
            description: Any type
        default:
          type: boolean
    type_:VendorDataResponsePaymentMethod:
      type: string
      enum:
        - value: vcard
        - value: ach
        - value: check
        - value: card
    type_:Vendorstatus:
      type: integer
    type_:Vendorid:
      type: integer
    type_:VendorResponseSummary:
      type: object
      properties:
        ActiveBills:
          type: integer
        PendingBills:
          type: integer
        InTransitBills:
          type: integer
        PaidBills:
          type: integer
        OverdueBills:
          type: integer
        ApprovedBills:
          type: integer
        DisapprovedBills:
          type: integer
        TotalBills:
          type: integer
        ActiveBillsAmount:
          type: number
          format: double
        PendingBillsAmount:
          type: number
          format: double
        InTransitBillsAmount:
          type: number
          format: double
        PaidBillsAmount:
          type: number
          format: double
        OverdueBillsAmount:
          type: number
          format: double
        ApprovedBillsAmount:
          type: number
          format: double
        DisapprovedBillsAmount:
          type: number
          format: double
        TotalBillsAmount:
          type: number
          format: double
    type_:Remitaddress1:
      type: string
    type_:Remitaddress2:
      type: string
    type_:Remitcity:
      type: string
    type_:Remitstate:
      type: string
    type_:Remitzip:
      type: string
    type_:Remitcountry:
      type: string
    type_:PayeeName:
      type: string
    type_:InternalReferenceId:
      type: integer
      format: int64
    type_:AdditionalDataMap:
      type: object
      additionalProperties:
        type: string
    type_:VendorResponseStoredMethod:
      type: object
      properties:
        IdPmethod:
          type:
            - string
            - 'null'
        Method:
          type:
            - string
            - 'null'
        Descriptor:
          type:
            - string
            - 'null'
        MaskedAccount:
          type:
            - string
            - 'null'
        ExpDate:
          type:
            - string
            - 'null'
        HolderName:
          type:
            - string
            - 'null'
        AchSecCode:
          type:
            - string
            - 'null'
        AchHolderType:
          type:
            - string
            - 'null'
        IsValidatedACH:
          type:
            - boolean
            - 'null'
        BIN:
          type:
            - string
            - 'null'
        binData:
          type:
            - string
            - 'null'
        ABA:
          type:
            - string
            - 'null'
        PostalCode:
          type:
            - string
            - 'null'
        MethodType:
          type:
            - string
            - 'null'
        LastUpdated:
          type:
            - string
            - 'null'
          format: date-time
        CardUpdatedOn:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - IdPmethod
        - Method
        - Descriptor
        - MaskedAccount
        - ExpDate
        - HolderName
        - AchSecCode
        - AchHolderType
        - IsValidatedACH
        - BIN
        - binData
        - ABA
        - PostalCode
        - MethodType
        - LastUpdated
        - CardUpdatedOn
    type_:VendorDataResponse:
      type: object
      properties:
        VendorNumber:
          $ref: '#/components/schemas/type_:VendorNumber'
        Name1:
          type: string
          description: Primary name for vendor.
        Name2:
          type: string
          description: Secondary name for vendor.
        EIN:
          type: string
          description: >-
            EIN/Tax ID for vendor. In responses, this field is masked, and looks
            like: `"ein": "XXXXX6789"`.
        Phone:
          type: string
          description: Vendor's phone number.
        Email:
          $ref: '#/components/schemas/type_:Email'
        RemitEmail:
          type: string
          description: Email address for remittance
        Address1:
          type: string
          description: Vendor's address.
        Address2:
          type: string
          description: Additional line for vendor's address.
        City:
          type: string
          description: Vendor's city.
        State:
          type: string
          description: Vendor's state. Must be a two-character state code.
        Zip:
          type: string
          description: Vendor's zip code.
        Country:
          type: string
          description: Vendor's country. Payabli supports only US and Canadian vendors.
        Mcc:
          $ref: '#/components/schemas/type_:Mcc'
        LocationCode:
          $ref: '#/components/schemas/type_:LocationCode'
        Contacts:
          type: array
          items:
            $ref: '#/components/schemas/type_:ContactsResponse'
          description: Array of objects describing the vendor's contacts.
        BillingData:
          $ref: '#/components/schemas/type_:VendorResponseBillingData'
          description: Object containing vendor's bank information.
        PaymentMethod:
          $ref: '#/components/schemas/type_:VendorDataResponsePaymentMethod'
          description: Preferred payment method for vendor.
        VendorStatus:
          $ref: '#/components/schemas/type_:Vendorstatus'
        VendorId:
          $ref: '#/components/schemas/type_:Vendorid'
        EnrollmentStatus:
          type: string
          description: Vendor enrollment status
        Summary:
          $ref: '#/components/schemas/type_:VendorResponseSummary'
          description: Vendor bill summary statistics
        PaypointLegalname:
          type: string
          description: Legal name of the paypoint
        PaypointDbaname:
          type: string
          description: DBA name of the paypoint
        PaypointEntryname:
          type: string
          description: Entry name of the paypoint
        ParentOrgName:
          type: string
          description: Name of the parent organization
        ParentOrgId:
          type: integer
          description: ID of the parent organization
        CreatedDate:
          type: string
          format: date-time
          description: Date when vendor was created
        LastUpdated:
          type: string
          format: date-time
          description: Date when vendor was last updated
        remitAddress1:
          $ref: '#/components/schemas/type_:Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/type_:Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/type_:Remitcity'
        remitState:
          $ref: '#/components/schemas/type_:Remitstate'
        remitZip:
          $ref: '#/components/schemas/type_:Remitzip'
        remitCountry:
          $ref: '#/components/schemas/type_:Remitcountry'
        payeeName1:
          $ref: '#/components/schemas/type_:PayeeName'
        payeeName2:
          $ref: '#/components/schemas/type_:PayeeName'
        customField1:
          type: string
          description: Custom field 1 for vendor
        customField2:
          type: string
          description: Custom field 2 for vendor
        customerVendorAccount:
          type: string
          description: Account number of paypoint in the Vendor side.
        InternalReferenceId:
          $ref: '#/components/schemas/type_:InternalReferenceId'
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalDataMap'
        externalPaypointID:
          type: string
          description: External paypoint identifier
        StoredMethods:
          type: array
          items:
            $ref: '#/components/schemas/type_:VendorResponseStoredMethod'
          description: Array of stored payment methods for vendor
      required:
        - VendorNumber
        - Name1
        - Name2
        - EIN
        - Phone
        - Email
        - Address1
        - Address2
        - City
        - State
        - Zip
        - Country
        - Mcc
        - LocationCode
        - Contacts
        - BillingData
        - PaymentMethod
        - VendorStatus
        - VendorId
        - Summary
        - PaypointLegalname
        - PaypointDbaname
        - PaypointEntryname
        - ParentOrgName
        - ParentOrgId
        - CreatedDate
        - LastUpdated
        - remitAddress1
        - remitAddress2
        - remitCity
        - remitState
        - remitZip
        - remitCountry
        - payeeName1
        - payeeName2
        - customField1
        - customField2
        - InternalReferenceId
        - additionalData
        - externalPaypointID
        - StoredMethods
    type_:Billstatus:
      type: integer
    type_:CreatedAt:
      type: string
      format: date-time
    type_:LastModified:
      type: string
      format: date-time
    type_:Frequency:
      type: string
      enum:
        - value: onetime
        - value: weekly
        - value: every2weeks
        - value: every6months
        - value: monthly
        - value: every3months
        - value: annually
    type_:Comments:
      type: string
    type_:AdditionalData:
      type: object
      additionalProperties:
        type: object
        additionalProperties:
          description: Any type
    type_:AddressNullable:
      type: string
    type_:AddressAddtlNullable:
      type: string
    type_:BankName:
      type: string
    type_:RoutingAccount:
      type: string
    type_:AccountNumber:
      type: string
    type_:TypeAccount:
      type: string
      enum:
        - value: Checking
        - value: Savings
    type_:BankAccountHolderName:
      type: string
    type_:BankAccountHolderType:
      type: string
      enum:
        - value: Personal
        - value: Business
    type_:BillingDataResponse:
      type: object
      properties:
        id:
          type: integer
          description: The bank's ID in Payabli.
        accountId:
          description: Any type
        nickname:
          type: string
        bankName:
          $ref: '#/components/schemas/type_:BankName'
        routingAccount:
          $ref: '#/components/schemas/type_:RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/type_:AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/type_:TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/type_:BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/type_:BankAccountHolderType'
        bankAccountFunction:
          type: integer
          description: >-
            Describes whether the bank account is used for deposits or
            withdrawals in Payabli:
              - `0`: Deposit
              - `1`: Withdrawal 
              - `2`: Deposit and withdrawal
        verified:
          type: boolean
        status:
          type: integer
        services:
          type: array
          items:
            description: Any type
        default:
          type: boolean
      required:
        - id
        - nickname
        - bankName
        - routingAccount
        - accountNumber
        - typeAccount
        - bankAccountHolderName
        - bankAccountHolderType
        - bankAccountFunction
        - verified
        - status
        - services
        - default
    type_:CityNullable:
      type: string
    type_:Ein:
      type: string
    type_:EnrollmentStatus:
      type: string
    type_:ExternalPaypointId:
      type: string
    type_:OrgParentName:
      type: string
    type_:OrgParentId:
      type: integer
      format: int64
    type_:VendorPaymentMethodString:
      type: string
    type_:Dbaname:
      type: string
    type_:Entrypointfield:
      type: string
    type_:Legalname:
      type: string
    type_:RemitEmail:
      type: string
      format: email
    type_:StateNullable:
      type: string
    type_:VendorSummary:
      type: object
      properties:
        ActiveBills:
          type: integer
        PendingBills:
          type: integer
        InTransitBills:
          type: integer
        PaidBills:
          type: integer
        OverdueBills:
          type: integer
        ApprovedBills:
          type: integer
        DisapprovedBills:
          type: integer
        TotalBills:
          type: integer
        ActiveBillsAmount:
          type: number
          format: double
        PendingBillsAmount:
          type: number
          format: double
        InTransitBillsAmount:
          type: number
          format: double
        PaidBillsAmount:
          type: number
          format: double
        OverdueBillsAmount:
          type: number
          format: double
        ApprovedBillsAmount:
          type: number
          format: double
        DisapprovedBillsAmount:
          type: number
          format: double
        TotalBillsAmount:
          type: number
          format: double
    type_:Zip:
      type: string
    type_:VendorQueryRecord:
      type: object
      properties:
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalData'
        Address1:
          $ref: '#/components/schemas/type_:AddressNullable'
        Address2:
          $ref: '#/components/schemas/type_:AddressAddtlNullable'
        BillingData:
          $ref: '#/components/schemas/type_:BillingDataResponse'
        City:
          $ref: '#/components/schemas/type_:CityNullable'
        Contacts:
          $ref: '#/components/schemas/type_:ContactsResponse'
        Country:
          type: string
        CreatedDate:
          $ref: '#/components/schemas/type_:CreatedAt'
        customerVendorAccount:
          type: string
        customField1:
          type: string
        customField2:
          type: string
        EIN:
          $ref: '#/components/schemas/type_:Ein'
        Email:
          $ref: '#/components/schemas/type_:Email'
        EnrollmentStatus:
          $ref: '#/components/schemas/type_:EnrollmentStatus'
        externalPaypointID:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        InternalReferenceId:
          $ref: '#/components/schemas/type_:InternalReferenceId'
        LastUpdated:
          $ref: '#/components/schemas/type_:LastModified'
        LocationCode:
          type: string
        Mcc:
          $ref: '#/components/schemas/type_:Mcc'
        Name1:
          type: string
        Name2:
          type: string
        ParentOrgName:
          $ref: '#/components/schemas/type_:OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/type_:OrgParentId'
        payeeName1:
          $ref: '#/components/schemas/type_:PayeeName'
        payeeName2:
          $ref: '#/components/schemas/type_:PayeeName'
        PaymentMethod:
          $ref: '#/components/schemas/type_:VendorPaymentMethodString'
        PaypointDbaname:
          $ref: '#/components/schemas/type_:Dbaname'
        PaypointEntryname:
          $ref: '#/components/schemas/type_:Entrypointfield'
        PaypointLegalname:
          $ref: '#/components/schemas/type_:Legalname'
        Phone:
          type: string
        remitAddress1:
          $ref: '#/components/schemas/type_:Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/type_:Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/type_:Remitcity'
        remitCountry:
          $ref: '#/components/schemas/type_:Remitcountry'
        RemitEmail:
          $ref: '#/components/schemas/type_:RemitEmail'
        remitState:
          $ref: '#/components/schemas/type_:Remitstate'
        remitZip:
          $ref: '#/components/schemas/type_:Remitzip'
        State:
          $ref: '#/components/schemas/type_:StateNullable'
        StoredMethods:
          type: array
          items:
            $ref: '#/components/schemas/type_:VendorResponseStoredMethod'
        Summary:
          $ref: '#/components/schemas/type_:VendorSummary'
        VendorId:
          $ref: '#/components/schemas/type_:Vendorid'
        VendorNumber:
          $ref: '#/components/schemas/type_:VendorNumber'
        VendorStatus:
          $ref: '#/components/schemas/type_:Vendorstatus'
        Zip:
          $ref: '#/components/schemas/type_:Zip'
    type_:Netamountnullable:
      type: number
      format: double
    type_:FeeAmount:
      type: number
      format: double
    type_:Source:
      type: string
    type_:Orgid:
      type: integer
      format: int64
    type_:FileContentFtype:
      type: string
      enum:
        - value: pdf
        - value: doc
        - value: docx
        - value: jpg
        - value: jpeg
        - value: png
        - value: gif
        - value: txt
    type_:FileContent:
      type: object
      properties:
        fContent:
          type: string
          description: >-
            Content of file, Base64-encoded. Ignored if furl is specified. Max
            upload size is 30 MB.
        filename:
          type: string
          description: The name of the attached file.
        ftype:
          $ref: '#/components/schemas/type_:FileContentFtype'
          description: The MIME type of the file (if content is provided)
        furl:
          type: string
          description: Optional URL provided to show or download the file remotely
    type_:PaymentIdString:
      type: string
    type_:Accountexp:
      type: string
    type_:Accountid:
      type: string
    type_:Accounttype:
      type: string
    type_:Accountzip:
      type: string
    type_:BinData:
      type: object
      properties:
        binMatchedLength:
          type: string
          description: |-
            The number of characters from the beginning of the card number that
            were matched against a Bank Identification Number (BIN) or the Card
            Range table.
        binCardBrand:
          type: string
          description: |-
            The card brand. For example, Visa, Mastercard, American Express,
            Discover.
        binCardType:
          type: string
          description: 'The type of card: Credit or Debit.'
        binCardCategory:
          type: string
          description: >-
            The category of the card, which indicates the card product. For
            example: Standard, Gold, Platinum, etc. The binCardCategory for
            prepaid cards is marked `PREPAID`.
        binCardIssuer:
          type: string
          description: The name of the financial institution that issued the card.
        binCardIssuerCountry:
          type: string
          description: The issuing financial institution's country name.
        binCardIssuerCountryCodeA2:
          type: string
          description: >-
            The issuing financial institution's two-character ISO country code.
            See [this resource](https://www.iso.org/obp/ui/#search) for a list
            of codes.
        binCardIssuerCountryNumber:
          type: string
          description: >-
            The issuing financial institution's ISO standard numeric country
            code. See [this resource](https://www.iso.org/obp/ui/#search) for a
            list of codes.
        binCardIsRegulated:
          type: string
          description: Indicates whether the card is regulated.
        binCardUseCategory:
          type: string
          description: The use category classification for the card.
        binCardIssuerCountryCodeA3:
          type: string
          description: >-
            The issuing financial institution's three-character ISO country
            code.

            See [this resource](https://www.iso.org/obp/ui/#search) for a list
            of

            codes.
    type_:Holdername:
      type: string
    type_:Initiator:
      type: string
    type_:Maskedaccount:
      type: string
    type_:Orderdescription:
      type: string
    type_:PaymentCategories:
      type: object
      properties:
        amount:
          type: number
          format: double
          description: Price/cost per unit of item or category.
        description:
          type: string
          description: Description of item or category
        label:
          type: string
          description: Name of item or category.
        qty:
          type: integer
          default: 1
          description: Quantity of item or category
      required:
        - amount
        - label
    type_:SplitFundingContent:
      type: object
      properties:
        accountId:
          type: string
          description: The accountId for the account the split should be sent to.
        amount:
          type: number
          format: double
          description: Amount from the transaction to sent to this recipient.
        description:
          type: string
          description: A description for the split.
        recipientEntryPoint:
          type: string
          description: The entrypoint the split should be sent to.
    type_:SplitFunding:
      type: array
      items:
        $ref: '#/components/schemas/type_:SplitFundingContent'
    type_:PaymentDetail:
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/type_:PaymentCategories'
          description: >-
            Array of payment categories/line items describing the amount to be
            paid.

            **Note**: These categories are for information only and aren't
            validated against the total amount provided.
        checkImage:
          type: object
          additionalProperties:
            description: Any type
          description: Object containing image of paper check.
        checkNumber:
          type: string
          description: >-
            A check number to be used in the ach transaction. **Required** for
            payment method = 'check'.
        currency:
          type: string
          description: >-
            The currency for the transaction, `USD` or `CAD`. If your paypoint
            is configured for CAD, you must send the `CAD` value in this field,
            otherwise it defaults to USD, which will cause the transaction to
            fail.
        serviceFee:
          type: number
          format: double
          description: >-
            Service fee to be deducted from the total amount. This amount must
            be a number, percentages aren't accepted. If you are using a
            percentage-based fee schedule, you must calculate the value
            manually.
        splitFunding:
          $ref: '#/components/schemas/type_:SplitFunding'
          description: >-
            Split funding instructions for the transaction. See [Split a
            Transaction](/developers/developer-guides/money-in-split-funding)
            for more.
        totalAmount:
          type: number
          format: double
          description: >-
            Total amount to be charged. If a service fee is sent, then this
            amount should include the service fee."
      required:
        - totalAmount
    type_:Sequence:
      type: string
    type_:Signaturedata:
      type: string
    type_:Storedmethodid:
      type: string
    type_:StoredMethodUsageType:
      type: string
    type_:QueryPaymentData:
      type: object
      properties:
        AccountExp:
          $ref: '#/components/schemas/type_:Accountexp'
        accountId:
          $ref: '#/components/schemas/type_:Accountid'
        AccountType:
          $ref: '#/components/schemas/type_:Accounttype'
        AccountZip:
          $ref: '#/components/schemas/type_:Accountzip'
        binData:
          $ref: '#/components/schemas/type_:BinData'
        HolderName:
          $ref: '#/components/schemas/type_:Holdername'
        Initiator:
          $ref: '#/components/schemas/type_:Initiator'
        MaskedAccount:
          $ref: '#/components/schemas/type_:Maskedaccount'
        orderDescription:
          $ref: '#/components/schemas/type_:Orderdescription'
        paymentDetails:
          $ref: '#/components/schemas/type_:PaymentDetail'
        Sequence:
          $ref: '#/components/schemas/type_:Sequence'
        SignatureData:
          $ref: '#/components/schemas/type_:Signaturedata'
        StoredId:
          $ref: '#/components/schemas/type_:Storedmethodid'
          description: Identifier of stored payment method used in transaction.
        StoredMethodUsageType:
          $ref: '#/components/schemas/type_:StoredMethodUsageType'
    type_:InvoiceNumber:
      type: string
    type_:NetAmountstring:
      type: string
    type_:Attachments:
      type: array
      items:
        $ref: '#/components/schemas/type_:FileContent'
    type_:BillPayOutData:
      type: object
      properties:
        billId:
          type: integer
          format: int64
          description: Bill ID in Payabli.
        comments:
          $ref: '#/components/schemas/type_:Comments'
          description: >-
            Any comments about bill. **For managed payouts, this field has a
            limit of 100 characters**.
        dueDate:
          $ref: '#/components/schemas/type_:Datenullable'
          description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceDate:
          $ref: '#/components/schemas/type_:Datenullable'
          description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceNumber:
          $ref: '#/components/schemas/type_:InvoiceNumber'
          description: >-
            Custom number identifying the bill. Must be unique in paypoint.
            **Required** for new bill and when `billId` isn't provided.
        netAmount:
          $ref: '#/components/schemas/type_:NetAmountstring'
          description: Net Amount owed in bill. Required when adding a bill.
        discount:
          type: string
          description: Bill discount amount.
        Terms:
          $ref: '#/components/schemas/type_:Terms'
          description: Description of payment terms.
        AccountingField1:
          $ref: '#/components/schemas/type_:AccountingField'
        AccountingField2:
          $ref: '#/components/schemas/type_:AccountingField'
        AdditionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
        attachments:
          $ref: '#/components/schemas/type_:Attachments'
          description: >-
            Bill image attachment. Send the bill image as Base64-encoded string,
            or as a publicly accessible link. For full details on using this
            field with a payout authorization, see [the
            documentation](/developers/developer-guides/pay-out-manage-payouts).
    type_:QueryTransactionEventsEventData:
      oneOf:
        - type: object
          additionalProperties:
            description: Any type
        - type: string
    type_:QueryTransactionEvents:
      type: object
      properties:
        EventData:
          $ref: '#/components/schemas/type_:QueryTransactionEventsEventData'
          description: >-
            Any data associated to the event received from processor. Contents
            vary by event type.
        EventTime:
          type: string
          format: date-time
          description: Date and time of event.
        TransEvent:
          type: string
          description: >-
            Event descriptor. See [TransEvent
            Reference](/guides/pay-in-transevents-reference) for more details.
    type_:Gatewayfield:
      type: string
    type_:HasVcardTransactions:
      type: boolean
    type_:IsSameDayACH:
      type: boolean
    type_:ScheduleId:
      type: integer
      format: int64
    type_:SettlementStatusPayout:
      type: string
    type_:RiskFlagged:
      type: boolean
    type_:RiskFlaggedOn:
      type: string
      format: date-time
    type_:RiskStatus:
      type: string
    type_:RiskReason:
      type: string
    type_:RiskAction:
      type: string
    type_:RiskActionCode:
      type: integer
    type_:PayoutProgram:
      type: string
    type_:TransactionOutQueryRecord:
      type: object
      properties:
        IdOut:
          type: integer
          format: int64
          description: Identifier of payout transaction.
        CreatedAt:
          $ref: '#/components/schemas/type_:CreatedAt'
        Comments:
          $ref: '#/components/schemas/type_:Comments'
          description: Any comment or description for payout transaction.
        Vendor:
          $ref: '#/components/schemas/type_:VendorQueryRecord'
          description: Vendor related to the payout transaction.
        PaypointDbaname:
          $ref: '#/components/schemas/type_:Dbaname'
        PaypointLegalname:
          $ref: '#/components/schemas/type_:Legalname'
        Status:
          type: integer
          description: Internal status of transaction.
        LastUpdated:
          $ref: '#/components/schemas/type_:LastModified'
          description: Timestamp when payment record was updated, in UTC.
        TotalAmount:
          type: number
          format: double
          description: Transaction total amount (including service fee or sub-charge).
        NetAmount:
          $ref: '#/components/schemas/type_:Netamountnullable'
        FeeAmount:
          $ref: '#/components/schemas/type_:FeeAmount'
        Source:
          $ref: '#/components/schemas/type_:Source'
        ParentOrgName:
          $ref: '#/components/schemas/type_:OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/type_:Orgid'
        BatchNumber:
          type: string
          description: The batch number for the payout transaction.
        PaymentStatus:
          type: string
          description: Status of payout transaction.
        PaymentMethod:
          type: string
          description: Method of payment applied to the transaction.
        CardToken:
          type: string
        CheckNumber:
          type: string
          description: Paper check number related to payout transaction.
        CheckData:
          $ref: '#/components/schemas/type_:FileContent'
          description: Object referencing to paper check image.
        PaymentId:
          $ref: '#/components/schemas/type_:PaymentIdString'
        PaymentData:
          $ref: '#/components/schemas/type_:QueryPaymentData'
        Bills:
          type: array
          items:
            $ref: '#/components/schemas/type_:BillPayOutData'
          description: Events associated to this transaction.
        Events:
          type: array
          items:
            $ref: '#/components/schemas/type_:QueryTransactionEvents'
          description: Events associated to this transaction.
        externalPaypointID:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        EntryName:
          $ref: '#/components/schemas/type_:Entrypointfield'
        Gateway:
          $ref: '#/components/schemas/type_:Gatewayfield'
        BatchId:
          type: string
          description: ID of the batch the transaction belongs to.
        HasVcardTransactions:
          $ref: '#/components/schemas/type_:HasVcardTransactions'
        IsSameDayACH:
          $ref: '#/components/schemas/type_:IsSameDayACH'
        ScheduleId:
          $ref: '#/components/schemas/type_:ScheduleId'
        SettlementStatus:
          $ref: '#/components/schemas/type_:SettlementStatusPayout'
        RiskFlagged:
          $ref: '#/components/schemas/type_:RiskFlagged'
        RiskFlaggedOn:
          $ref: '#/components/schemas/type_:RiskFlaggedOn'
        RiskStatus:
          $ref: '#/components/schemas/type_:RiskStatus'
        RiskReason:
          $ref: '#/components/schemas/type_:RiskReason'
        RiskAction:
          $ref: '#/components/schemas/type_:RiskAction'
        RiskActionCode:
          $ref: '#/components/schemas/type_:RiskActionCode'
        PayoutProgram:
          $ref: '#/components/schemas/type_:PayoutProgram'
    type_:GeneralEvents:
      type: object
      properties:
        description:
          type: string
          description: Event description.
        eventTime:
          type: string
          format: date-time
          description: Event timestamp, in UTC.
        extraData:
          type: object
          additionalProperties:
            description: Any type
          description: Extra data.
        refData:
          type: string
          description: Reference data.
        source:
          $ref: '#/components/schemas/type_:Source'
          description: The event source.
    type_:BillEvents:
      type: array
      items:
        $ref: '#/components/schemas/type_:GeneralEvents'
    type_:DatetimeNullable:
      type: string
      format: date-time
    type_:BillQueryRecord2BillApprovalsItem:
      type: object
      properties:
        approved:
          type: integer
          description: >-
            Indicates whether the bill has been approved. `0` is false, and `1`
            is true.
        approvedTime:
          $ref: '#/components/schemas/type_:DatetimeNullable'
          description: Timestamp of when the approval was made, in UTC.
        comments:
          type: string
          description: Additional comments on the approval.
        email:
          $ref: '#/components/schemas/type_:Email'
          description: The approving user's email address.
        Id:
          type: integer
          format: int64
          description: The approving user's ID.
    type_:BillApprovals:
      type: array
      items:
        $ref: '#/components/schemas/type_:BillQueryRecord2BillApprovalsItem'
    type_:PaylinkId:
      type: string
    type_:PairFiles:
      type: object
      properties:
        originalName:
          type: string
          description: Original filename
        zipName:
          type: string
          description: >-
            Filename assigned to zipped file. This is the name to use for
            reference in the API functions to get files in attachments.
        descriptor:
          type: string
          description: Descriptor of the file.
    type_:DocumentsRef:
      type: object
      properties:
        filelist:
          type: array
          items:
            $ref: '#/components/schemas/type_:PairFiles'
          description: Array of objects describing files contained in the ZIP file.
        zipfile:
          type: string
          description: Zip file containing attachments.
    type_:EntityId:
      type: integer
      format: int64
    type_bill:BillResponseData:
      type: object
      properties:
        IdBill:
          $ref: '#/components/schemas/type_:BillId'
        BillNumber:
          type: string
          description: Unique identifier for the bill.
        NetAmount:
          type: number
          format: double
          description: Net amount owed in bill.
        Discount:
          type: number
          format: double
          description: Bill discount amount.
        TotalAmount:
          type: number
          format: double
          description: Total amount for the bill.
        BillDate:
          $ref: '#/components/schemas/type_:Datenullable'
          description: 'Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY'
        DueDate:
          $ref: '#/components/schemas/type_:Datenullable'
          description: 'Due Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY'
        Comments:
          type: string
          description: >-
            Comments associated with the bill. For managed payables, the
            character limit is 200. For on demand payouts, the characters limit
            is 250.
        BatchNumber:
          type: string
          description: The batch number that the bill belongs to.
        BillItems:
          $ref: '#/components/schemas/type_:Billitems'
          description: Array of `LineItems` contained in bill.
        Mode:
          type: integer
          description: >-
            Bill mode: value `0` for single/one-time bills, `1` for scheduled
            bills.
        PaymentMethod:
          type: string
          description: Payment method used for the bill.
        PaymentId:
          type: string
          description: Payment ID associated with the bill.
        AccountingField1:
          $ref: '#/components/schemas/type_:AccountingField'
        AccountingField2:
          $ref: '#/components/schemas/type_:AccountingField'
        Terms:
          $ref: '#/components/schemas/type_:Terms'
        Source:
          type: string
          description: The source of the bill, such as "API" or "UI".
        AdditionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
        Vendor:
          $ref: '#/components/schemas/type_:VendorDataResponse'
        Status:
          $ref: '#/components/schemas/type_:Billstatus'
        CreatedAt:
          $ref: '#/components/schemas/type_:CreatedAt'
        EndDate:
          $ref: '#/components/schemas/type_:Datenullable'
          description: End date for scheduled bills. Applied only in `Mode` = 1.
        LastUpdated:
          $ref: '#/components/schemas/type_:LastModified'
        Frequency:
          $ref: '#/components/schemas/type_:Frequency'
          description: Frequency for scheduled bills. Applied only in `Mode` = 1.
        Transaction:
          $ref: '#/components/schemas/type_:TransactionOutQueryRecord'
          description: MoneyOut transaction associated to the bill
        billEvents:
          $ref: '#/components/schemas/type_:BillEvents'
        billApprovals:
          $ref: '#/components/schemas/type_:BillApprovals'
        PaypointLegalname:
          $ref: '#/components/schemas/type_:Legalname'
        PaypointDbaname:
          $ref: '#/components/schemas/type_:Dbaname'
        ParentOrgId:
          $ref: '#/components/schemas/type_:OrgParentId'
        ParentOrgName:
          $ref: '#/components/schemas/type_:OrgParentName'
        PaypointEntryname:
          $ref: '#/components/schemas/type_:Entrypointfield'
        paylinkId:
          $ref: '#/components/schemas/type_:PaylinkId'
        DocumentsRef:
          $ref: '#/components/schemas/type_:DocumentsRef'
          description: Object with the attached documents.
        externalPaypointID:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        LotNumber:
          type: string
          description: Lot number of the bill.
        EntityID:
          $ref: '#/components/schemas/type_:EntityId'
    type_bill:GetBillResponse:
      type: object
      properties:
        responseCode:
          $ref: '#/components/schemas/type_:Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        roomId:
          $ref: '#/components/schemas/type_:RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/type_:IsSuccess'
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
        responseData:
          $ref: '#/components/schemas/type_bill:BillResponseData'
      required:
        - responseText

```

## SDK Code Examples

```python GetBillbyId
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.bill.get_bill(
    id_bill=285,
)

```

```typescript GetBillbyId
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.bill.getBill(285);

```

```go GetBillbyId
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Bill.GetBill(
	context.TODO(),
	285,
)

```

```csharp GetBillbyId
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Bill.GetBillAsync(285);

```

```ruby GetBillbyId
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Bill/285")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java GetBillbyId
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Bill/285")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php GetBillbyId
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Bill/285', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift GetBillbyId
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Bill/285")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```