REST API Attributes
This section provides additional details about the resources and supported attributes for the POST and PATCH actions.
Invoices
Invoices is the top-level resource that contains the information required to create and manage a payables invoice. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| LastUpdateDate |
No |
No |
| LastUpdatedBy |
No |
No |
| Supplier |
Yes |
No |
| InvoiceNumber |
Yes |
Yes |
| InvoiceCurrency |
Yes |
No |
| PaymentCurrency |
Yes |
No |
| InvoiceAmount |
Yes |
Yes |
| SupplierSite |
Yes |
No |
| AmountPaid |
No |
No |
| InvoiceDate |
Yes |
Yes |
| InvoiceSourceCode |
Yes |
No |
| InvoiceSource |
Yes |
No |
| InvoiceType |
Yes |
No |
| Description |
Yes |
Yes |
| InvoiceGroup |
Yes |
No |
| PaymentTerms |
Yes |
Yes |
| TermsDate |
Yes |
Yes |
| PayGroup |
Yes |
Yes |
| LiabilityDistribution |
Yes |
No |
| PaidStatus |
No |
No |
| CreationDate |
No |
No |
| CreatedBy |
No |
No |
| BaseAmount |
No |
No |
| LastUpdateLogin |
No |
No |
| PayAloneFlag |
Yes |
Yes |
| PurchaseOrderNumber |
Yes |
No |
| GoodsReceivedDate |
Yes |
Yes |
| InvoiceReceivedDate |
Yes |
Yes |
| VoucherNumber |
Yes |
No |
| ApplyAfterDate |
Yes |
Yes |
| DocumentSequence |
Yes |
No |
| DocumentCategory |
Yes |
No |
| ValidationStatus |
No |
No |
| CanceledDate |
No |
No |
| CanceledBy |
No |
No |
| BusinessUnit |
Yes |
No |
| AccountingDate |
Yes |
No |
| ApprovalStatus |
No |
No |
| Requester |
Yes |
Yes |
| RequesterId |
Yes |
Yes |
| TaxationCountry |
Yes |
Yes |
| DocumentFiscalClassificationCodePath |
Yes |
Yes |
| LegalEntity |
Yes |
Yes |
| PaymentReason |
Yes |
Yes |
| PaymentReasonComments |
Yes |
Yes |
| PaymentMethod |
Yes |
No |
| DeliveryChannel |
Yes |
Yes |
| ControlAmount |
Yes |
Yes |
| Party |
No |
No |
| PartySite |
No |
No |
| ConversionRateType |
Yes |
Yes |
| ConversionRate |
Yes |
Yes |
| ConversionDate |
Yes |
Yes |
| BudgetDate |
Yes |
Yes |
| FundsStatus |
No |
No |
| FirstPartyTaxRegistrationNumber |
Yes |
Yes |
| SupplierTaxRegistrationNumber |
Yes |
No |
| UniqueRemittanceIdentifier |
Yes |
Yes |
| UniqueRemittanceIdentifierCheckDigit |
Yes |
Yes |
| RoutingAttribute1 |
No |
No |
| RoutingAttribute2 |
Yes |
Yes |
| RoutingAttribute3 |
Yes |
Yes |
| RoutingAttribute4 |
Yes |
Yes |
| RoutingAttribute5 |
No |
No |
| AccountCodingStatus |
No |
No |
| SupplierNumber |
Transient |
Transient |
| ProcurementBU |
Transient |
Transient |
| DeliveryChannelCode |
Transient |
Transient |
| PaymentReasonCode |
Transient |
Transient |
| PaymentMethodCode |
Transient |
Transient |
| LegalEntityIdentifier |
Transient |
Transient |
| AccountingStatus |
No |
No |
| CanceledFlag |
No |
No |
| FirstPartyTaxRegistrationId |
Yes |
Yes |
| RemittanceMessageOne |
Yes |
Yes |
| RemittanceMessageTwo |
Yes |
Yes |
| RemittanceMessageThree |
Yes |
Yes |
| BankAccount |
Transient |
No |
| SupplierIBAN |
Transient |
No |
| ExternalBankAccountId |
Yes |
No |
| BankChargeBearer |
Yes |
Yes |
| SettlementPriority |
Yes |
Yes |
| ReferenceKeyOne |
No |
No |
| ReferenceKeyTwo |
No |
No |
| ReferenceKeyThree |
No |
No |
| ReferenceKeyFour |
No |
No |
| ReferenceKeyFive |
No |
No |
| ProductTable |
No |
No |
| ImageDocumentNumber |
No |
No |
Invoice Descriptive Flexfields
Invoices Descriptive Flexfields is a child-level resource of Invoices. This resource is used to create and manage details about the descriptive flexfield references for an invoice. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoices Global Descriptive Flexfields
Invoices Global Descriptive Flexfields is a child-level resource of Invoices. This resource is used to create and manage details about the global descriptive flexfield references for an invoice. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoices Lines
Invoice Lines is a child-level resource of Invoices and consists of the attributes of the lines within the invoice. The line-level attributes describe the information related to each line-level content. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| LineNumber |
Yes |
No |
| LineType |
Yes |
No |
| Requester |
Yes |
Yes |
| RequesterId |
Yes |
Yes |
| Description |
Yes |
Yes |
| LineSource |
No |
No |
| Item |
Yes |
No |
| ItemDescription |
No |
No |
| GenerateDistributions |
No |
No |
| MatchType |
No |
No |
| DistributionSet |
Yes |
Yes |
| DistributionCombination |
Yes |
No |
| ProrateAcrossAllItemsFlag |
Yes |
Yes |
| AccountingDate |
Yes |
No |
| MultiperiodAccountingStartDate |
Yes |
Yes |
| MultiperiodAccountingEndDate |
Yes |
Yes |
| LineAmount |
Yes |
Yes |
| Quantity |
Yes |
No |
| UOM |
Yes |
No |
| UnitPrice |
Yes |
No |
| ApprovalStatus |
No |
No |
| DiscardedFlag |
No |
No |
| CanceledFlag |
No |
No |
| IncomeTaxRegion |
Yes |
Yes |
| IncomeTaxType |
Yes |
Yes |
| PurchaseOrderNumber |
Yes |
No |
| PurchaseOrderLineNumber |
Yes |
No |
| PurchaseOrderScheduleLineNumber |
Yes |
No |
| ReceiptNumber |
Yes |
No |
| FinalMatchFlag |
Yes |
Yes |
| TrackAsAssetFlag |
Yes |
No |
| AssetBook |
Yes |
No |
| AssetCategory |
Yes |
No |
| Withholding |
Yes |
Yes |
| CreationDate |
No |
No |
| CreatedBy |
No |
No |
| LastUpdatedBy |
No |
No |
| LastUpdateDate |
No |
No |
| LastUpdateLogin |
No |
No |
| PurchasingCategory |
No |
No |
| TaxControlAmount |
Yes |
Yes |
| AssessableValue |
Yes |
Yes |
| IntendedUse |
Yes |
Yes |
| ShipToLocation |
Yes |
Yes |
| ProductType |
Yes |
Yes |
| ProductCategory |
Yes |
Yes |
| ProductFiscalClassification |
Yes |
Yes |
| UserDefinedFiscalClassification |
Yes |
Yes |
| TransactionBusinessCategory |
Yes |
Yes |
| TaxRateCode |
No |
No |
| TaxRate |
No |
No |
| TaxClassification |
Yes |
Yes |
| ReceiptLineNumber |
Yes |
No |
| BudgetDate |
Yes |
Yes |
| FundsStatus |
No |
No |
| LandedCostEnabled |
Yes |
Yes |
| ConsumptionAdviceNumber |
Yes |
No |
| ConsumptionAdviceLineNumber |
Yes |
No |
| ShipToCustomerLocation |
Yes |
Yes |
| MultiperiodAccountingAccrualAccount |
Yes |
Yes |
| TaxRateName |
No |
No |
| ShipToLocationCode |
Transient |
Transient |
| ProductCategoryCodePath |
Transient |
Transient |
| UserDefinedFiscalClassificationCode |
Transient |
Transient |
| IntendedUseCode |
Transient |
Transient |
| ProductFiscalClassificationCode |
Transient |
Transient |
| ProductFiscalClassificationType |
Transient |
Transient |
| TransactionBusinessCategoryCodePath |
Transient |
Transient |
| MatchOption |
No |
No |
| MatchBasis |
No |
No |
| PrepaymentNumber |
No |
No |
| PrepaymentLineNumber |
No |
No |
| PrepaymentIncludedonInvoiceFlag |
No |
No |
| ReferenceKeyTwo |
No |
No |
| ProductTable |
No |
No |
Invoice Lines Descriptive Flexfields
Invoice Lines Descriptive Flexfields is a child-level resource of Invoice Lines. This resource is used to create and manage details about the descriptive flexfield references for an invoice line. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| LineNumber |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoice Lines Global Descriptive Flexfields
Invoice Lines Global Descriptive Flexfields is a child-level resource of Invoice Lines. This resource is used to create and manage details about the global descriptive flexfield references for an invoice line. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| LineNumber |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoice Lines Project Descriptive Flexfields
Invoice Lines Project Descriptive Flexfields is a child-level resource of Invoice Lines. This resource is used to create and manage details about the project information for an invoice line. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| LineNumber |
No |
No |
| __FLEX_Context |
No |
No |
| __FLEX_Context_DisplayValue |
No |
No |
Note:
When an invoice line is created, the project context AP_Invoice_Line is already populated by default. So, for the project attributes that are not listed here, provide values as per your use cases, for example, create or update project information for an invoice line.
Invoice Distributions
Invoice Distributions is a child-level resource of Invoice Lines. It's used to manage details required to create accounting entries. This includes information such as accounting date and distribution combinations. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| AccountingDate |
Yes |
Yes |
| TrackAsAssetFlag |
Yes |
Yes |
| DistributionLineNumber |
Yes |
No |
| DistributionCombination |
Yes |
Yes |
| LastUpdatedBy |
No |
No |
| LastUpdateDate |
No |
No |
| DistributionLineType |
Yes |
Yes |
| DistributionAmount |
Yes |
Yes |
| BaseAmount |
No |
No |
| CreatedBy |
No |
No |
| CreationDate |
No |
No |
| Description |
Yes |
Yes |
| FinalMatchFlag |
No |
No |
| IncomeTaxRegion |
Yes |
Yes |
| LastUpdateLogin |
No |
No |
| ValidationStatus |
No |
No |
| AccountingStatus |
No |
No |
| PurchaseOrderDistributionLineNumber |
No |
No |
| InvoicedQuantity |
No |
No |
| ReversedFlag |
No |
No |
| IncomeTaxType |
Yes |
Yes |
| UnitPrice |
Yes |
No |
| MatchedStatus |
No |
No |
| ReceiptNumber |
No |
No |
| InvoiceDistributionId |
No |
No |
| TaxRecoverable |
No |
No |
| UOM |
No |
No |
| CanceledFlag |
No |
No |
| AssociatedItemDistributionLineNumber |
No |
No |
| AssetBook |
Yes |
Yes |
| IntendedUse |
Yes |
Yes |
| TaxRateName |
No |
No |
| TaxType |
No |
No |
| TaxRate |
No |
No |
| ConsumptionAdviceNumber |
No |
No |
| ConsumptionAdviceLineNumber |
No |
No |
| MultiperiodAccountingAccrualAccount |
Yes |
Yes |
| MultiperiodAccountingStartDate |
Yes |
Yes |
| MultiperiodAccountingEndDate |
Yes |
Yes |
| PurchaseOrderNumber |
No |
No |
| PurchaseOrderLineNumber |
No |
No |
| PurchaseOrderScheduleLineNumber |
No |
No |
| ReceiptLineNumber |
No |
No |
| TaxRegimeName |
No |
No |
| TaxName |
No |
No |
| IntendedUseCode |
Transient |
Transient |
| PrepaymentNumber |
No |
No |
| PrepaymentLineNumber |
No |
No |
| PrepaymentDistributionLineNumber |
No |
No |
| PrepaymentAvailableAmountv |
No |
No |
| BudgetDate |
Yes |
Yes |
Invoice Distributions Descriptive Flexfields
Invoice Distribution Descriptive Flexfields is a child-level resource of Invoice Distributions. This resource is used to create and manage details about the descriptive flexfield references for an invoice distribution. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceDistributionId |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoice Distributions Global Descriptive Flexfields
Invoice Distribution Global Descriptive Flexfields is a child-level resource of Invoice Distributions. This resource is used to create and manage details about the global descriptive flexfield references for an invoice distribution. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceDistributionId |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoice Distributions Project Descriptive Flexfields
Invoice Distributions Project Descriptive Flexfields is a child-level resource of Invoice Distributions. This resource is used to create and manage details about the project information for an invoice distribution. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceDistributionId |
No |
No |
| __FLEX_Context |
No |
No |
| __FLEX_Context_DisplayValue |
No |
No |
Note:
When an invoice distribution is created, the project context AP_Invoice_Distribution is already populated by default. So, for the project attributes that are not listed here, provide values as per your use cases, for example, create or update project information for an invoice distribution.
Invoice Installments
Invoice Installments is a child-level resource of Invoices. This resource is used to manage details about the payment due dates, amounts, and other payment information. An invoice can have one or more installments. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| HeldBy |
No |
No |
| HoldDate |
No |
No |
| LastUpdatedBy |
No |
No |
| LastUpdateDate |
No |
No |
| InstallmentNumber |
Yes |
No |
| UnpaidAmount |
No |
No |
| CreatedBy |
No |
No |
| CreationDate |
No |
No |
| FirstDiscountDate |
Yes |
Yes |
| DueDate |
Yes |
Yes |
| GrossAmount |
Yes |
Yes |
| HoldFlag |
Yes |
Yes |
| LastUpdateLogin |
No |
No |
| PaymentPriority |
Yes |
Yes |
| SecondDiscountDate |
Yes |
Yes |
| ThirdDiscountDate |
Yes |
Yes |
| FirstDiscountAmount |
Yes |
Yes |
| SecondDiscountAmount |
Yes |
Yes |
| ThirdDiscountAmount |
Yes |
Yes |
| ExternalBankAccountId |
Yes |
Yes |
| HoldReason |
Yes |
Yes |
| PaymentMethod |
Yes |
Yes |
| RemitToSupplier |
Yes |
Yes |
| RemitToAddressName |
Yes |
Yes |
| NetAmountOne |
No |
No |
| NetAmountTwo |
No |
No |
| NetAmountThree |
No |
No |
| HoldType |
No |
No |
| PaymentMethodCode |
Transient |
Transient |
| BankAccount |
Yes |
Yes |
Invoice Installments Descriptive Flexfields
Invoice Installments Descriptive Flexfields is a child-level resource of Invoice Installments resource. This resource is used to create and manage details about the descriptive flexfield references for an invoice installment. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| InstallmentNumber |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Invoice Installments Global Descriptive Flexfields
Invoice Installments Global Descriptive Flexfields is a child-level resource of Invoice Installments. This resource is used to create and manage details about the global descriptive flexfield references for an invoice installment. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| InvoiceId |
No |
No |
| InstallmentNumber |
No |
No |
| __FLEX_Context |
Yes |
Yes |
| __FLEX_Context_DisplayValue |
No |
No |
Attachments
Attachments is a child-level resource of Invoices. This resource is used to create and manage attachments that the user has attached to the invoice. Here are some additional details:
| Attribute Name | Supports POST | Supports PATCH |
|---|---|---|
| AttachedDocumentId |
No |
No |
| LastUpdateDate |
No |
No |
| LastUpdatedBy |
No |
No |
| FileName |
Yes |
No |
| DmFolderPath |
Yes |
No |
| Url |
Yes |
No |
| Uri |
Yes |
No |
| FileUrl |
Yes |
No |
| UploadedText |
Yes |
No |
| UploadedFileContentType |
Yes |
No |
| UploadedFileLength |
Yes |
No |
| UploadedFileName |
Yes |
No |
| ContentRepositoryFileShared |
Yes |
No |
| Title |
Yes |
No |
| Description |
Yes |
No |
| ErrorStatusCode |
No |
No |
| ErrorStatusMessage |
No |
No |
| CreatedBy |
No |
No |
| CreationDate |
No |
No |
| FileContents |
Yes |
No |
| ExpirationDate |
Yes |
No |
| LastUpdatedByUserName |
No |
No |
| CreatedByUserName |
No |
No |
| Category |
Yes |
No |
| Type |
Yes |
No |