younifyd
Menu

Get Accounts Receivable Invoice Key

Get an invoice

GET/objects/accounts-receivable/invoice/{key}

Use it in a workflow

  1. Add a step and choose the Sage Intacct connector.
  2. Pick the Get Accounts Receivable Invoice Key action (under Sage Intacct).
  3. Fill in the fields below, then reference the result from later steps as {{getAccountsReceivableInvoiceKey.response.data}}.

Request

Path parameters

keystringrequired

System-assigned key for the invoice.

Response

Returns 200 with an object. Read it in later steps with {{getAccountsReceivableInvoiceKey.response.data.<field>}}.

ia::resultobject

An AR invoice object represents an invoice sent to a customer for goods or services provided.

keystring

System-assigned key for the AR invoice.

idstring

Unique identifier for the AR invoice.

actionstring

This field has been deprecated. Use the `state` field instead.

One ofsubmitdraftDefault "submit"

recordTypestring

The record type for the invoice.

moduleKeystring

Key of the module from which the invoice was created.

One ofaccountsReceivableorderEntryDefault "accountsReceivable"

invoiceNumberstring

Specify a unique invoice number while creating an invoice unless document sequencing is configured, in which case the number is auto-generated.

statestring

An invoice's state shows the current status of the invoice within the workflow. The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation.

One ofreversedreversaldraftnoValuepostedpaidpartiallyPaidselectedDefault "posted"

dueInDaysinteger

Number of days until the invoice is due.

referenceNumberstring

Customer purchase order number or another reference number.

descriptionstring

Description of the invoice, which prints on the Customer Ledger report.

documentIdstring

This field is deprecated, please use `salesDocument` field instead.

salesDocumentobject3 fields
discountCutOffDatestring (date)

Date of the discount.

invoiceDatestring (date)

Date the invoice was created.

dueDatestring (date)

Date the invoice is due.

currencyobject3 fields

Currency details for this invoice.

totalBaseAmountstring (decimal-precision-2)

For multi-currency companies, total entered in the base currency of the company.

totalBaseAmountDuestring (decimal-precision-2)

For multi-currency companies, total due in the base currency of the company.

totalTxnAmountstring (decimal-precision-2)

Total transaction amount in the currency of the invoice.

totalTxnAmountDuestring (decimal-precision-2)

Total transaction amount due in the currency of the invoice.

dunningCountinteger

Number of associated dunning notices.

customerMessageobject4 fields

Message to include on the customer's invoice.

recurringScheduleobject1 fields

Recurring schedule used to automate the billing process.

paymentInformationobject7 fields

Payment information for the invoice.

contactsobject2 fields

Associated contacts

isSystemGeneratedDocumentboolean

If `true`, this invoice record is created by the system internally and not created based on user input.

Default false

billbackTemplateobject3 fields

If AR is configured for inter-entity bill back, the template to use to create a matching bill.

createAPBillboolean

**Deprecated.** This field is no longer required and will be ignored. The matching bill is now created automatically when `billbackTemplate` is provided, if AR is configured for inter-entity bill back.

Default false

attachmentobject3 fields

Supporting document attached to the invoice.

customerobject7 fields

Customer to receive the invoice.

termobject3 fields

Term details for the invoice.

taxSolutionobject3 fields

Tax solution details for this invoice.

invoiceTypestring

Specifies whether the transaction is a regular invoice (invoice), an electronic invoice (eInvoice), or an invoice reported to the tax agency because it is not eligible for e-invoicing (eReporting).

One ofnullinvoiceeInvoiceeReporting

invoiceModestring

Invoice mode for France e-invoicing workflows; applicable only for France e-invoice enabled entities. Specifies the invoice mode based on invoiceType. For eReporting, specify tlb1 (goods) or tps1 (services). For eInvoice, specify b1 or s1. Supported values: - `tlb1` - E-Reporting mode for goods. - `tps1` - E-Reporting mode for services. - `b1` - Submission of an e-invoice for goods. - `s1` - Submission of an e-invoice for services. Leave this field blank when `invoiceType` is `invoice`.

One ofnulltlb1tps1b1s1

eInvoiceStatusstring

Current status of an e-invoice; applicable only when selected invoice type is eInvoice. Supported statuses: - `submitted` - The supplier submits its invoice or credit note to the public invoicing portal or its registered private platform. - `issuedByPlatform` - The invoice has been processed on the supplier’s platform and issued to the buyer. - `fileUploaded` - The invoice file has been uploaded to the platform. - `madeAvailable` - The invoice has been made available to the buyer on the public invoicing portal or its registered private platform. - `inHand` - The invoice is assumed by the buyer for processing. - `refused` - The invoice has been refused by the recipient for business reasons. A complete list of reasons for refusal is available in the document "Annex 1 - Semantic Format FE e-invoicing - Flows 1 & 2" on the "Reason for refusal" tab. - `paymentSent` - The bank transfer flow has been sent to the supplier / The reimbursement flow has been sent to the buyer. - `paymentReceived` - The supplier has received payment of the invoice. This status is mandatory for supply of services (except VAT on debits and excluding reverse charge transactions). - `disputed` - There is a dispute regarding the invoice. This may ultimately lead to refusal or approval by the buyer. - `notSent` - The invoice has not been sent to the platform. - `inTransit` - The invoice has been sent and is in transit between platforms. - `approved` - The invoice has been approved by the buyer. - `receivedByPlatform` - The invoice has been received by the public invoicing portal or the buyer’s registered private platform but has not yet been made available to the buyer. - `rejectedByPlatform` - The invoice can be automatically rejected by the platform on technical grounds (e.g. format, non-compliance with the standard, etc.). When the transmit platform rejects the invoice, the invoice must be corrected by its issuer and resubmitted to the platform. - `suspended` - Processing of the invoice is temporarily suspended. - `completed` - The invoice processing lifecycle is completed. - `partiallyApproved` - The invoice has been partially approved.

One ofnullsubmittedissuedByPlatformfileUploadedmadeAvailableinHandrefusedpaymentSentpaymentReceiveddisputednotSentinTransitapprovedreceivedByPlatformrejectedByPlatformsuspendedcompletedpartiallyApproved

disputeobject2 fields

France E-invoicing dispute information.

refuseobject2 fields

France E-invoicing refusal information.

invoiceSummaryobject6 fields

Summary details for this invoice. Summaries are collections of the same types of transactions grouped together for processing.

downloadURLstring (outbound-binary)

Contains download link for an invoice.

allowOnlinePaymentboolean

Indicates whether online payment through a Payment Acceptance Services (PAS), like Stripe or PayPal, is enabled for this invoice.

Default false

ia::metaobject

Metadata for the response.

totalCountinteger

Total count.

totalSuccessinteger

Total success.

totalErrorinteger

Total errors.

json
{
  "ia::result": {
    "key": "11",
    "id": "11",
    "action": "submit",
    "recordType": "ri",
    "moduleKey": "accountsReceivable",
    "invoiceNumber": "INV-001",
    "state": "posted",
    "dueInDays": 108,
    "referenceNumber": "PO6917",
    "description": "Regular invoice",
    "documentId": "string",
    "salesDocument": {
      "id": "Sales Invoice-SI-00188",
      "key": "511",
      "href": "/objects/order-entry/document/511"
    }
  },
  "ia::meta": {
    "totalCount": 3,
    "totalSuccess": 2,
    "totalError": 1
  }
}

Need more? See the Sage Intacct guide for connection setup and behaviour shared by every action.