AccountsPayables

Queryable, Introduced in version 2.27

GET https://localhost:8001/sv/001.1/api/v1/Accounting/AccountsPayables

Represents a account's payable.

GUID

7C342374-541F-4841-ADF9-5925130FD07F

Required permission

Show accounts payable

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the account's payable.
Version Int32 The version of the account's payable.
CancelCommentId Int64? The business key identifier of the account payable's cancellation comment.
CancelComment Comments The cancellation comment of the account payable.

  • Expandable
PaymentMethodId Int64? The business key identifier of the account payable's payment method.
LanguageId Int64 The business key identifier of the account payable's language.
Language LanguageCodes The language of the account payable.

  • Expandable
SuppliersInvoiceNumber String The human readable identifier of the supplier's invoice number.

  • Max length is 30
InvoiceType Int32 The invoice type of the accounts payable.

  • Standard: 1
  • Interest: 4
  • OnAccount: 5
  • ForOrderingOnAccount: 8
  • CorrectionInvoice: 9
IsCredit Boolean Specifies if the accounts payable is a credit or not.
IsFinalBooked Boolean Specifies if the accounts payable is final booked or not.
PurchaseOrderId Int64? The business key identifier of the account payable's purchase order.
WarehouseId Int64 The business key identifier of the warehouse that the accounts payable belongs to.
PreliminaryBookingDate DateTimeOffset? The date of the preliminary booking.
VoucherDate DateTimeOffset? The voucher date of the account payable.
CancelVoucherDate DateTimeOffset? The voucher cancellation date of the account payable.
SupplierAccountGroupId Int64? The business key identifier of the supplier account group of the acounts payable.
CountryId Int64 The business key identifier of the account payable's country.
Status Int32 The status of the accounts payable invoice.

  • Registered: 0
  • Preliminary: 1
  • Final: 2
  • Cancelled: 6
BlockMessageId Int64? The business key identifier of the entity block message comment.

References Comments.
BlockMessage Comments The block message of the account payable.

  • Expandable
OCRNumber String The OCR number of the account payable.

  • Max length is 30
UseOCRNumber Boolean Specifies if OCR number is used.
CreditedAccountsPayableId Int64? The business key identifier of the account payable's credit account payable.
BlockedById Int64? The business key identifier of the application user that blocked the entity.
BlockedBy ApplicationUsers The application user that blocked the account payable.

  • Expandable
BlockedFromDate DateTimeOffset? The date when the entity starts being blocked.
BlockedToDate DateTimeOffset? The date when the entity stops being blocked.
BlockedStatus Int32 The block status of the entity.

  • None: 0
  • Message: 1
  • Blocked: 2
BlockedContextType Int32 Specifies which contexts the block applies for.

  • None: 0
  • Payment: 1

  • Bitmask
HasEimInvoice Boolean Specifies if the account payable has EIM invoice.
HoldEimInvoice Boolean Specifies if the EIM invoice is on hold.
EimInvoiceStatus Int32 Specifies the status of the EIM invoice.

  • None: 0
  • Hold: 1
  • ForAuthorization: 2
  • Approved: 3
  • Rejected: 4
  • FinalBooked: 5
InvoiceNumber Int64 The invoice number of the accounts payable.
InvoiceDate DateTimeOffset The invoice date on the account payable.
DueDate DateTimeOffset The due date on the account payable.
InvoiceAmount Decimal The invoice amount on the account payable.
InvoiceAmountCurrencyId Int64? The business key identifier of the invoice amount currency.
InvoiceAmountInCompanyCurrency Decimal The invoice amount in the company currency.
InvoiceAmountInCompanyCurrencyCurrencyId Int64? The business key identifier of the company currency for the invoice amount.
VatAmount Decimal The VAT amount on the account payable.
VatAmountCurrencyId Int64? The business key identifier of the invoice vat amount currency.
VatAmountInCompanyCurrency Decimal The VAT amount in company currency.
VatAmountInCompanyCurrencyCurrencyId Int64? The business key identifier of the company currency for the invoice vat amount.
RestAmount Decimal The rest amount on the account payable.
RestAmountCurrencyId Int64? The business key identifier of the invoice rest amount currency.
RestAmountInCompanyCurrency Decimal The rest amount in company currency.
RestAmountInCompanyCurrencyCurrencyId Int64? The business key identifier of the company currency for the invoice rest amount.
OrderedRestAmount Decimal The ordered rest amount on the account payable.
OrderedRestAmountCurrencyId Int64? The business key identifier of the invoice ordered rest amount currency.
CurrencyId Int64? The business key identifier of the currency on the account payable.
ExchangeRate Decimal The exchange rate on the account payable.
PaidInFullDate DateTimeOffset? Specifies the date when the account payable was paid in full.
CommentId Int64? The business key identifier of the account payable's comment.
Comment Comments The internal comment of the account payable.

  • Expandable
ReferenceNumber String The human readable reference number on the account payable.

  • Max length is 35
UseFixedDueDate Boolean Specifies if a fixed due date is used.
VatGroupId Int64? The business key identifier of the VAT group that the account payable belongs to.
PaymentTermId Int64? The business key identifier of the payment term of the account payable.
PaymentTerm PaymentTerms The payment term of the account payable.

  • Expandable
FinalBookingId Int64? The business key identifier of the account payable's final booking.

References Booking.
 Introduced in version 2.41.1
BusinessContactId Int64 The business key identifier of the supplier that the accounts payable belongs to.

 Introduced in version 22.5
CurrencyExchangeTypeId Int64 The business key identifier of the accounts payable's currency exchange type.

 Introduced in version 22.9
Payments OutgoingPayments[] The payments of the accounts payable.

  • Expandable
 Introduced in version 24.2

Example

{
  "Id": 0,
  "Version": 0,
  "CancelCommentId": null,
  "CancelComment": null,
  "PaymentMethodId": null,
  "LanguageId": 0,
  "Language": null,
  "SuppliersInvoiceNumber": null,
  "InvoiceType": 0,
  "IsCredit": false,
  "IsFinalBooked": false,
  "PurchaseOrderId": null,
  "WarehouseId": 0,
  "PreliminaryBookingDate": null,
  "VoucherDate": null,
  "CancelVoucherDate": null,
  "SupplierAccountGroupId": null,
  "CountryId": 0,
  "Status": 0,
  "BlockMessageId": null,
  "BlockMessage": null,
  "OCRNumber": null,
  "UseOCRNumber": false,
  "CreditedAccountsPayableId": null,
  "BlockedById": null,
  "BlockedBy": null,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "BlockedStatus": 0,
  "BlockedContextType": 0,
  "HasEimInvoice": false,
  "HoldEimInvoice": false,
  "EimInvoiceStatus": 0,
  "InvoiceNumber": 0,
  "InvoiceDate": "0001-01-01T00:00:00+00:00",
  "DueDate": "0001-01-01T00:00:00+00:00",
  "InvoiceAmount": 0.0,
  "InvoiceAmountCurrencyId": null,
  "InvoiceAmountInCompanyCurrency": 0.0,
  "InvoiceAmountInCompanyCurrencyCurrencyId": null,
  "VatAmount": 0.0,
  "VatAmountCurrencyId": null,
  "VatAmountInCompanyCurrency": 0.0,
  "VatAmountInCompanyCurrencyCurrencyId": null,
  "RestAmount": 0.0,
  "RestAmountCurrencyId": null,
  "RestAmountInCompanyCurrency": 0.0,
  "RestAmountInCompanyCurrencyCurrencyId": null,
  "OrderedRestAmount": 0.0,
  "OrderedRestAmountCurrencyId": null,
  "CurrencyId": null,
  "ExchangeRate": 0.0,
  "PaidInFullDate": null,
  "CommentId": null,
  "Comment": null,
  "ReferenceNumber": null,
  "UseFixedDueDate": false,
  "VatGroupId": null,
  "PaymentTermId": null,
  "PaymentTerm": null,
  "FinalBookingId": null,
  "BusinessContactId": 0,
  "CurrencyExchangeTypeId": 0,
  "Payments": null
}