Invoices

mdx

<HTMLBlock>{`
<div>Here you will see how <mark>invoices</mark> can be generated, listed and displayed</div>

<style></style>
`}</HTMLBlock>

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Field
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        **id**
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Unique identifier for the invoice. This field is read-only.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **amount\_cents**\
        *integer*
      </td>

      <td style={{ textAlign: "left" }}>
        Invoice amount in specified currency's smallest unit. e.g. $10 would be represented as 1000. min\_value=1. max\_value=999999900
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **currency**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Currency to be used for invoice payment. The accepted value is "USD"
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **discount\_amount\_cents**\
        *integer*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional invoice discount amount in specified currency's smallest unit. min\_value=1. max\_value=999999900
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **invoice\_number**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Uniquely identifies an invoice for the recipient. Allowed characters for this field are ted, listed and displayed
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **invoice\_date**\
        *date*
      </td>

      <td style={{ textAlign: "left" }}>
        Date of invoice provided by recipient. Must be +/- 365 days from today.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **invoice\_due\_date**\
        *date*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional invoice due date
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **note**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        The optional additional information you would like to include regarding this invoice. Max-length = 1000.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **originating\_counterparty\_id**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        The ID of one of your organization's internal counterparties (Buyer) that will send payment.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **receiving\_counterparty\_id**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        The ID of one of your external counterparty (Supplier) that will receive invoice payment.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **metadata**\
        *object*
      </td>

      <td style={{ textAlign: "left" }}>
        Additional private data represented as key-value pairs. Both the key and value must be strings or integers.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **payment\_id**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        The id of the most recent Payment associated with this invoice. This field is read-only.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **reconciliation\_id**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        A string to identify the invoice in your accounting system. Max-length = 50
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **account\_number**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Account number. This sensitive information is stored encrypted and can only be retrieved through the API. Max-length = 250.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **created**\
        *timestamp*
      </td>

      <td style={{ textAlign: "left" }}>
        Date the Invoice was created.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **updated**\
        *timestamp*
      </td>

      <td style={{ textAlign: "left" }}>
        Date the Invoice was last updated.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **payment\_group\_id**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional value that will be used to group invoices into payments. When specified, only invoices with the same value will be included in a single payment.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **can\_be\_resubmitted**\
        *boolean*
      </td>

      <td style={{ textAlign: "left" }}>
        Indicates if the same invoice number can be submitted again. Resubmitting the same invoice number for a specific buyer and supplier is only allowed if the prior payment was refunded.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **accounting\_id**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Max-length = 70.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **status**\
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Current invoice status:  

        * \*pending\*\*: Invoice is being prepared for payment.  
        * \*in-progress\*\*: Payment for this invoice is in-progress.  
        * \*sent\*\*:  
        * \*complete\*\*: Payment for this invoice has been resolved.  
        * \*failed\*\*: An exception has occurred during payment processing.  
        * \*canceled\*\*: Funding for payment has an unrecoverable failure, or a pre-funding stop was performed.
      </td>
    </tr>
  </tbody>
</Table>