Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
swanny85 committed Jan 4, 2024
1 parent e88f514 commit ee92aa7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,14 @@ report = Fulfil::Report.new(client: fulfil, report_name: 'account.tax.summary.ir
report.execute(start_date: Date.new(2020, 12, 1), end_date: Date.new(2020, 12, 31))
```

## Date Ranges
Fulfil expects an ISO8601 date when retrieving a date range. The GEM will take a `date` or `datetime` and parse it into the object Fulfil expects.

```
datetime = DateTime.new(2024, 1, 1, 12, 0, 0)
fulfil_model.search(domain: [['create_date', '>=', datetime]])
```

## Rate limits

Fulfil's API applies rate limits to the API requests that it receives. Every request is subject to throttling under the general limits. In addition, there are resource-based rate limits and throttles.
Expand Down

0 comments on commit ee92aa7

Please sign in to comment.