AccountsReceivables

Queryable, Introduced in version 2.44

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

Represents an accounts receivable.

GUID

93690592-6919-4221-822a-1f8bfbca9ce9

Required permission

Show accounts receivable

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the accounts receivable.
Version Int32 The version of the accounts receivable.
BookingId Int64? The business key identifier of the booking that the accounts receivable belongs to.

References Bookings
Booking Bookings The booking that the accounts receivable belongs to.

  • Expandable
InvoiceType Int32 The invoice type of the accounts receivable.

  • Standard: 1
  • Internal: 2
  • CashReceipt: 3
  • Interest: 4
  • OnAccount: 5
  • DebitNote: 6
  • ServiceTax: 7
  • CorrectionInvoice: 8
  • CollectiveCorrectionInvoice: 9
LatestReminderDate DateTimeOffset? The latest reminder date of the accounts receivable.
PaymentReminder Boolean Specifies if the accounts receivable has payment reminders.
NumberOfPaymentReminders Int32 The number of payment reminders that are left for the accounts receivable.
CollectionDate DateTimeOffset? The collection date of the accounts receivable.
Collection Boolean Specifies if the accounts receivable has been collected or not.
InterestType Int32 The interest type of the accounts receivable.

  • InterestInvoice: 0
  • NextRegularInvoice: 1
  • None: 2
IsComprehensive Boolean Specifies if the accounts receivable is comprehensive or not.
PartialInvoiceType Int32 Specifies how partial invoicing works for the accounts receivable.

  • NotInitialized: 0
  • InAdvance: 1
  • Delivery: 2
  • InArrears: 3
  • Text: 4
CustomerAccountGroupId Int64 The business key identifier of the customer account group for the accounts receivable.

References CustomerAccountGroups
CustomerAccountGroup CustomerAccountGroups The customer account group of the accounts receivable.

  • Expandable
DebitInvoiceId Int64? The business key identifier of the debit invoice that the accounts receivable belongs to.

References AccountsReceivables
OnAccountIncomingPaymentLedgerId Int64? The business key identifier of the incoming payment ledger for the accounts receivable.
OnAccountCancelledIncomingPaymentLedgerId Int64? The business key identifier of the cancelled incoming payment ledger for the accounts receivable.
IsEInvoiceExported Boolean Specifies if an e-invoice has been exported for the accounts receivable.
AccountsReceivableLedgerId Int64? The business key identifier of the accounts receivable ledger.
CancelledAccountsReceivableLedgerId Int64? The business key identifier of the cancelled accounts receivable ledger.
Status Int32 The status of the accounts receivable.

  • Approved: 0
  • Printed: 1
  • Cancelled: 2
LatePaymentFee Decimal? The late payment fee of the accounts receivable in percent.
CancelCommentId Int64? The business key identifier of the cancel comment of the accounts receivable.

References Comments
CancelComment Comments The cancel comment of the accounts receivable.

  • Expandable
CancelDate DateTimeOffset The cancel date of the accounts receivable.
CancelBookingId Int64? The business key identifier of the cancel booking that the accounts receivable belongs to.

References Bookings
CancelBooking Bookings The cancel booking that the accounts receivable belongs to.

  • Expandable
BusinessContactId Int64? The business key identifier of the customer that the accounts receivable belongs to.

References Customers
InvoiceNumber Int64 The human readable identifier of the accounts receivable.

  • Unique
InvoiceDate DateTimeOffset The invoice date of the accounts receivable.
DueDate DateTimeOffset The due date of the accounts receivable.
IsCredit Boolean Specifies if the accounts receivable is on credit or not.
InvoiceAmount Decimal The invoice amount of the accounts receivable.
InvoiceAmountCurrencyId Int64 The business key identifier of the accounts receivable’s invoice amount currency.

References Currencies
InvoiceAmountInCompanyCurrency Decimal The invoice amount of the accounts receivable in the company currency.
InvoiceAmountInCompanyCurrencyCurrencyId Int64 The business key identifier of the accounts receivable’s invoice amount company currency.

References Currencies
VatAmount Decimal The VAT amount of the accounts receivable.
VatAmountCurrencyId Int64 The business key identifier of the accounts receivable’s VAT amount currency.

References Currencies
VatAmountInCompanyCurrency Decimal The VAT amount of the accounts receivable in the company currency.
VatAmountInCompanyCurrencyCurrencyId Int64 The business key identifier of the accounts receivable’s VAT amount company currency.

References Currencies
RestAmount Decimal The rest amount of the accounts receivable.
RestAmountCurrencyId Int64 The business key identifier of the accounts receivable’s rest amount currency.

References Currencies
RestAmountInCompanyCurrency Decimal The rest amount of the accounts receivable in the company currency.
RestAmountInCompanyCurrencyCurrencyId Int64 The business key identifier of the accounts receivable’s rest amount company currency.

References Currencies
OrderedRestAmount Decimal The ordered rest amount of the accounts receivable.
OrderedRestAmountCurrencyId Int64? The business key identifier of the accounts receivable’s ordered rest amount currency.

References Currencies
CurrencyId Int64 The business key identifier of the accounts receivable currency.

References Currencies
ExchangeRate Decimal The exchange rate applicable to the accounts receivable.
PaidInFullDate DateTimeOffset? Specifies when the accounts receivable was paid in full.
CommentId Int64? The business key identifier of the accounts receivable comment.

References Comments
Comment Comments The comment of the accounts receivable.

  • Expandable
ReferenceNumber String The reference number of the accounts receivable.
UseFixedDueDate Boolean Specifies if the accounts receivable uses a fixed due date.
VatGroupId Int64 The business key identifier of the VAT group that the accounts receivable belongs to.

References VatGroups
PaymentTermId Int64 The business key identifier of the payment term that the accounts receivable belongs to.

References PaymentTerms
ChineseVatInvoiceNumber String The Chinese VAT invoice number of the accounts receivable.
ChineseVatInvoiceDate DateTimeOffset? The Chinese VAT invoice date of the accounts receivable.
CurrencyExchangeTypeId Int64 The business key identifier of the accounts receivable's currency exchange type.

 Introduced in version 22.9
CTCReportingInvoiceNumber String The invoice number for accounts receivable from CTC reporting system.
 Introduced in version 25.6
CTCReportingReasonForRejection String The reason for rejection accounts receivable in CTC reporting system.
 Introduced in version 25.6
CTCReportingStatus Int32? The accounts receivable's status from CTC reporting system.

  • NotSent: 0
  • SentForApproval: 1
  • Approved: 2
  • NotApproved: 3
  • Cancelled: 4
 Introduced in version 25.6
CTCReportingInvoiceDate DateTimeOffset? The accounts receivable's invoice date from CTC reporting system.
 Introduced in version 25.6
CTCReportingIdentifier String The accounts receivable's identifier from CTC reporting system.
 Introduced in version 25.6
CTCReportingElectronicConfirmationURL String The official electronic confirmation URL of receipt from CTC reporting system.
 Introduced in version 25.6
CTCReportingElectronicConfirmationNumber String The official electronic confirmation number of receipt from CTC reporting system.
 Introduced in version 25.6

Example

{
  "Id": 0,
  "Version": 0,
  "BookingId": null,
  "Booking": null,
  "InvoiceType": 0,
  "LatestReminderDate": null,
  "PaymentReminder": false,
  "NumberOfPaymentReminders": 0,
  "CollectionDate": null,
  "Collection": false,
  "InterestType": 0,
  "IsComprehensive": false,
  "PartialInvoiceType": 0,
  "CustomerAccountGroupId": 0,
  "CustomerAccountGroup": null,
  "DebitInvoiceId": null,
  "OnAccountIncomingPaymentLedgerId": null,
  "OnAccountCancelledIncomingPaymentLedgerId": null,
  "IsEInvoiceExported": false,
  "AccountsReceivableLedgerId": null,
  "CancelledAccountsReceivableLedgerId": null,
  "Status": 0,
  "LatePaymentFee": null,
  "CancelCommentId": null,
  "CancelComment": null,
  "CancelDate": "0001-01-01T00:00:00+00:00",
  "CancelBookingId": null,
  "CancelBooking": null,
  "BusinessContactId": null,
  "InvoiceNumber": 0,
  "InvoiceDate": "0001-01-01T00:00:00+00:00",
  "DueDate": "0001-01-01T00:00:00+00:00",
  "IsCredit": false,
  "InvoiceAmount": 0.0,
  "InvoiceAmountCurrencyId": 0,
  "InvoiceAmountInCompanyCurrency": 0.0,
  "InvoiceAmountInCompanyCurrencyCurrencyId": 0,
  "VatAmount": 0.0,
  "VatAmountCurrencyId": 0,
  "VatAmountInCompanyCurrency": 0.0,
  "VatAmountInCompanyCurrencyCurrencyId": 0,
  "RestAmount": 0.0,
  "RestAmountCurrencyId": 0,
  "RestAmountInCompanyCurrency": 0.0,
  "RestAmountInCompanyCurrencyCurrencyId": 0,
  "OrderedRestAmount": 0.0,
  "OrderedRestAmountCurrencyId": null,
  "CurrencyId": 0,
  "ExchangeRate": 0.0,
  "PaidInFullDate": null,
  "CommentId": null,
  "Comment": null,
  "ReferenceNumber": null,
  "UseFixedDueDate": false,
  "VatGroupId": 0,
  "PaymentTermId": 0,
  "ChineseVatInvoiceNumber": null,
  "ChineseVatInvoiceDate": null,
  "CurrencyExchangeTypeId": 0,
  "CTCReportingInvoiceNumber": null,
  "CTCReportingReasonForRejection": null,
  "CTCReportingStatus": null,
  "CTCReportingInvoiceDate": null,
  "CTCReportingIdentifier": null,
  "CTCReportingElectronicConfirmationURL": null,
  "CTCReportingElectronicConfirmationNumber": null
}