accounting_period_transactions_short
Georgia Kountouri
Name | Type | Description |
|---|---|---|
Set of Invoice objects | A list of Invoices which are related to the Accounting Period | |
| payments_set | Set of Payment objects | A list of Payments which are related to the Accounting Period |
| credit_notes_set | Set of Credit Note objects | A list of Credit Notes which are related to the Accounting Period |
| refunds_set | Set of Refunds objects | A list of Refunds which are related to the Accounting Period |
| payment_cancellations_set | Set of Payment Cancellation objects | A list of Payment Cancellations which are related to the Accounting Period |
| invoice_cancellation_set | Set of Invoice Cancellations objects | A list of Invoice Cancellations which are related to the Accounting Period |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved invoice |
number | String | The number of the retrieved invoice |
reference_number | String | The reference number of the retrieved invoice |
life_cycle_state | String | The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
| issued_on | Date | The date that the invoice was issued |
| posted_on | Date | The date that the invoice was posted |
| due_on | Date | The date that the credit period for that specific invoice is ending. |
| total_amount | Number | The total amount of the invoice |
| outstanding_amount | Number | The total outstanding amount of the invoice |
| unsettled_amount | Number | The total unsettled amount of the invoice |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment |
number | String | The number of the retrieved payment |
reference_number | String | The reference number of the retrieved payment |
life_cycle_state | String | The life cycle state of the payment. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED, PENDING_VERIFICATION |
| issued_on | Date | The date that the payment was issued |
| posted_on | Date | The date that the payment was posted |
| payment_amount | Number | The total amount of the payment |
| processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
| payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
| currency_rate_period | Currency Rate Period | The currency rate period based on which the refund was created Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved credit note |
number | String | The number of the retrieved credit note |
reference_number | String | The reference number of the retrieved credit note |
life_cycle_state | String | The life cycle state of the credit note. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
| issued_on | Date | The date that the credit note was issued |
| posted_on | Date | The date that the credit note was posted |
| total_amount | Number | The total amount of the credit note |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the credit note's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved refund |
number | String | The number of the retrieved refund |
reference_number | String | The reference number of the retrieved refund |
life_cycle_state | String | The life cycle state of the refund. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
| issued_on | Date | The date that the refund was issued |
| posted_on | Date | The date that the refund was posted |
| refund_amount | Number | The amount that was refunded |
| currency_rate_period | Currency Rate Period | The currency rate period based on which the refund was created Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment cancellation |
number | String | The number of the retrieved payment cancellation |
reference_number | String | The reference number of the retrieved payment cancellation |
life_cycle_state | String | The life cycle state of the payment cancellation. the only available value is POSTED. |
| issued_on | Date | The date that the payment cancellation was issued |
| posted_on | Date | The date that the payment cancellation was posted |
| payment_amount | Number | The total amount of the payment cancellation |
| processed_by_payment_gateway | String | The payment gateway that processed the payment cancellation |
| payment_gateway_reference_number | String | A reference to the number of the payment cancellation that was created on the payment gateway |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved invoice cancellation |
number | String | The number of the retrieved invoice cancellation |
reference_number | String | The reference number of the retrieved invoice cancellation |
life_cycle_state | String | The life cycle state of the invoice cancellation. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
| issued_on | Date | The date that the invoice cancellation was issued |
| posted_on | Date | The date that the invoice cancellation was posted |
| total_amount | Number | The total amount of the invoice cancellation |
| currency_rate_period | Currency Rate Period | The currency rate period based on which the invoice cancellation was created Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |